Create a new skill - Orq.ai Documentation

POST

skills

Core - Create project skill

curl --request POST \
  --url 'https://api.orq.ai/v2/skills' \
  --header 'Authorization: Bearer $ORQ_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "display_name": "summarize_support_ticket",
    "description": "Summarize support tickets into concise resolution notes.",
    "project_id": "proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V",
    "path": "/customer-success/skills/summarize-support-ticket",
    "tags": ["support", "summarization"],
    "instructions": "Read the ticket conversation and return the problem, customer sentiment, and proposed next step."
  }'

import { Orq } from '@orq-ai/node';

const client = new Orq({
  apiKey: process.env.ORQ_API_KEY,
});

const result = await client.skills.create({
  displayName: 'summarize_support_ticket',
  description: 'Summarize support tickets into concise resolution notes.',
  projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',
  path: '/customer-success/skills/summarize-support-ticket',
  tags: ['support', 'summarization'],
  instructions:
    'Read the ticket conversation and return the problem, customer sentiment, and proposed next step.',
});

console.log(result.skill.skillId);

import os
from orq_ai_sdk import Orq

client = Orq(api_key=os.environ["ORQ_API_KEY"])

result = client.skills.create(
    display_name="summarize_support_ticket",
    description="Summarize support tickets into concise resolution notes.",
    project_id="proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V",
    path="/customer-success/skills/summarize-support-ticket",
    tags=["support", "summarization"],
    instructions=(
        "Read the ticket conversation and return the problem, "
        "customer sentiment, and proposed next step."
    ),
)

print(result.skill.skill_id)

{
  "skill": {
    "skill_id": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "tags": [
      "<string>"
    ],
    "project_id": "<string>",
    "path": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_by_id": "<string>",
    "updated_by_id": "<string>",
    "instructions": "<string>",
    "version": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Option 1
Option 2

display_name

string

required

Workspace-unique display name. Must start with a letter and may contain letters, numbers, and underscores. Dashes and dots are not allowed.

path

string

required

Project path where the skill should be stored.

description

string

Short human-readable summary of what the skill is for.

Response

200 - application/json

skill

object

required

Newly created skill.

Show child attributes

List all skills

Retrieve a skill

⌘I

Core - Create project skill

curl --request POST \
  --url 'https://api.orq.ai/v2/skills' \
  --header 'Authorization: Bearer $ORQ_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "display_name": "summarize_support_ticket",
    "description": "Summarize support tickets into concise resolution notes.",
    "project_id": "proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V",
    "path": "/customer-success/skills/summarize-support-ticket",
    "tags": ["support", "summarization"],
    "instructions": "Read the ticket conversation and return the problem, customer sentiment, and proposed next step."
  }'

import { Orq } from '@orq-ai/node';

const client = new Orq({
  apiKey: process.env.ORQ_API_KEY,
});

const result = await client.skills.create({
  displayName: 'summarize_support_ticket',
  description: 'Summarize support tickets into concise resolution notes.',
  projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',
  path: '/customer-success/skills/summarize-support-ticket',
  tags: ['support', 'summarization'],
  instructions:
    'Read the ticket conversation and return the problem, customer sentiment, and proposed next step.',
});

console.log(result.skill.skillId);

import os
from orq_ai_sdk import Orq

client = Orq(api_key=os.environ["ORQ_API_KEY"])

result = client.skills.create(
    display_name="summarize_support_ticket",
    description="Summarize support tickets into concise resolution notes.",
    project_id="proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V",
    path="/customer-success/skills/summarize-support-ticket",
    tags=["support", "summarization"],
    instructions=(
        "Read the ticket conversation and return the problem, "
        "customer sentiment, and proposed next step."
    ),
)

print(result.skill.skill_id)

{
  "skill": {
    "skill_id": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "tags": [
      "<string>"
    ],
    "project_id": "<string>",
    "path": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_by_id": "<string>",
    "updated_by_id": "<string>",
    "instructions": "<string>",
    "version": "<string>"
  }
}