Create Skill
curl --request POST \
--url https://app.octavehq.com/api/v2/skill/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "<string>",
"description": "",
"content": "",
"contentJson": {},
"sourceMetadata": {
"resourceOId": "<string>",
"url": "<string>",
"eventOIds": [
"<string>"
],
"findingOIds": [
"<string>"
],
"exampleCount": 123
}
}
'import requests
url = "https://app.octavehq.com/api/v2/skill/create"
payload = {
"name": "<string>",
"description": "",
"content": "",
"contentJson": {},
"sourceMetadata": {
"resourceOId": "<string>",
"url": "<string>",
"eventOIds": ["<string>"],
"findingOIds": ["<string>"],
"exampleCount": 123
}
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '',
content: '',
contentJson: {},
sourceMetadata: {
resourceOId: '<string>',
url: '<string>',
eventOIds: ['<string>'],
findingOIds: ['<string>'],
exampleCount: 123
}
})
};
fetch('https://app.octavehq.com/api/v2/skill/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/skill/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '',
'content' => '',
'contentJson' => [
],
'sourceMetadata' => [
'resourceOId' => '<string>',
'url' => '<string>',
'eventOIds' => [
'<string>'
],
'findingOIds' => [
'<string>'
],
'exampleCount' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/skill/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"content\": \"\",\n \"contentJson\": {},\n \"sourceMetadata\": {\n \"resourceOId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventOIds\": [\n \"<string>\"\n ],\n \"findingOIds\": [\n \"<string>\"\n ],\n \"exampleCount\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/skill/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"content\": \"\",\n \"contentJson\": {},\n \"sourceMetadata\": {\n \"resourceOId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventOIds\": [\n \"<string>\"\n ],\n \"findingOIds\": [\n \"<string>\"\n ],\n \"exampleCount\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/skill/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"content\": \"\",\n \"contentJson\": {},\n \"sourceMetadata\": {\n \"resourceOId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventOIds\": [\n \"<string>\"\n ],\n \"findingOIds\": [\n \"<string>\"\n ],\n \"exampleCount\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"content": "<string>",
"artifactUuid": "<string>",
"active": true,
"createdAt": "2023-11-07T05:31:56Z",
"contentJson": {},
"sourceMetadata": {
"resourceOId": "<string>",
"url": "<string>",
"eventOIds": [
"<string>"
],
"findingOIds": [
"<string>"
],
"exampleCount": 123
},
"archivedAt": "2023-11-07T05:31:56Z",
"lockedAt": "2023-11-07T05:31:56Z",
"lockedByUser": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z",
"files": [
{
"path": "<string>",
"size": 123,
"mimeType": "<string>"
}
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
}
}Skill
Create Skill
Create a skill from frontmatter fields (name, description) and a markdown body. The composed SKILL.md is stored in the artifact store; new skills start as DRAFT until published. The API key’s creating user must be a workspace or organization owner.
POST
/
api
/
v2
/
skill
/
create
Create Skill
curl --request POST \
--url https://app.octavehq.com/api/v2/skill/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "<string>",
"description": "",
"content": "",
"contentJson": {},
"sourceMetadata": {
"resourceOId": "<string>",
"url": "<string>",
"eventOIds": [
"<string>"
],
"findingOIds": [
"<string>"
],
"exampleCount": 123
}
}
'import requests
url = "https://app.octavehq.com/api/v2/skill/create"
payload = {
"name": "<string>",
"description": "",
"content": "",
"contentJson": {},
"sourceMetadata": {
"resourceOId": "<string>",
"url": "<string>",
"eventOIds": ["<string>"],
"findingOIds": ["<string>"],
"exampleCount": 123
}
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '',
content: '',
contentJson: {},
sourceMetadata: {
resourceOId: '<string>',
url: '<string>',
eventOIds: ['<string>'],
findingOIds: ['<string>'],
exampleCount: 123
}
})
};
fetch('https://app.octavehq.com/api/v2/skill/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/skill/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '',
'content' => '',
'contentJson' => [
],
'sourceMetadata' => [
'resourceOId' => '<string>',
'url' => '<string>',
'eventOIds' => [
'<string>'
],
'findingOIds' => [
'<string>'
],
'exampleCount' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/skill/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"content\": \"\",\n \"contentJson\": {},\n \"sourceMetadata\": {\n \"resourceOId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventOIds\": [\n \"<string>\"\n ],\n \"findingOIds\": [\n \"<string>\"\n ],\n \"exampleCount\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/skill/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"content\": \"\",\n \"contentJson\": {},\n \"sourceMetadata\": {\n \"resourceOId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventOIds\": [\n \"<string>\"\n ],\n \"findingOIds\": [\n \"<string>\"\n ],\n \"exampleCount\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/skill/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"content\": \"\",\n \"contentJson\": {},\n \"sourceMetadata\": {\n \"resourceOId\": \"<string>\",\n \"url\": \"<string>\",\n \"eventOIds\": [\n \"<string>\"\n ],\n \"findingOIds\": [\n \"<string>\"\n ],\n \"exampleCount\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"content": "<string>",
"artifactUuid": "<string>",
"active": true,
"createdAt": "2023-11-07T05:31:56Z",
"contentJson": {},
"sourceMetadata": {
"resourceOId": "<string>",
"url": "<string>",
"eventOIds": [
"<string>"
],
"findingOIds": [
"<string>"
],
"exampleCount": 123
},
"archivedAt": "2023-11-07T05:31:56Z",
"lockedAt": "2023-11-07T05:31:56Z",
"lockedByUser": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z",
"files": [
{
"path": "<string>",
"size": 123,
"mimeType": "<string>"
}
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
}
}Authorizations
Body
application/json
Required string length:
1 - 64Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Maximum string length:
1024Show child attributes
Show child attributes
Available options:
draft, published Available options:
authored, imported, generated, uploaded Show child attributes
Show child attributes
⌘I