Skills

Operations for the Skills service collection.

Language	Last Update
Python	v1.6.6
PowerShell
Go
TypeScript
Rust
Ruby

---

Table of Contents

Operation	Description
EntitiesSkillsCreateV1 create_studio_skill	Upload a new skill as a zip archive.
EntitiesSkillsDeleteV1 delete_studio_skill	Delete a skill by its ID.
EntitiesSkillsDownloadV2 download_studio_skill	Download a single skill blob as a zip archive.
EntitiesSkillsUpdateV1 update_studio_skill	Update an existing skill with a new zip archive.
EntitiesSkillsV1 get_studio_skills	Retrieve skill entities for the provided IDs.
QueriesSkillsV1 query_studio_skills	Query skills based on the provided filters.

---

EntitiesSkillsCreateV1

Upload a new skill as a zip archive.

Method POST

Route /agentic-studio/entities/skills/v1

Scope Charlotte AI Agent Definition: WRITE

PEP 8 create_studio_skill

Parameters

skill_blob body · file

Skill zip archive to upload

file_name body · string

Name to use for the uploaded file.

Code Examples

Python

PEP 8

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.create_studio_skill(file_name="string", skill_blob="string")
print(response)

Operation ID

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.EntitiesSkillsCreateV1(file_name="string",
                                         skill_blob="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("EntitiesSkillsCreateV1",
                          skill_blob="string")
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 Successfully created

[
  {
    "attribution": {},
    "created_at": "string",
    "created_by": {},
    "description": "string",
    "id": "string",
    "is_deleted": false,
    "metadata": {},
    "name": "string",
    "updated_at": "string",
    "updated_by": {}
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

EntitiesSkillsDeleteV1

Delete a skill by its ID.

Method DELETE

Route /agentic-studio/entities/skills/v1

Scope Charlotte AI Agent Definition: WRITE

PEP 8 delete_studio_skill

Parameters

id query · string

ID of the skill to delete

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.delete_studio_skill(id=id_list)
print(response)

Operation ID

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.EntitiesSkillsDeleteV1(id=id_list)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("EntitiesSkillsDeleteV1",
                          id="string")
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 Successfully deleted

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

EntitiesSkillsDownloadV2

Download a single skill blob as a zip archive.

Method GET

Route /agentic-studio/entities/skills/download/v2

Scope Charlotte AI Agent Definition: READ

PEP 8 download_studio_skill

Parameters

id query · string

ID of the skill to download.

include_deleted query · boolean

Include deleted skills in the result. Defaults to false.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.download_studio_skill(id="string", include_deleted=boolean)
print(response)

Operation ID

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.EntitiesSkillsDownloadV2(id="string", include_deleted=boolean)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("EntitiesSkillsDownloadV2",
                          id="string",
                          include_deleted=boolean)
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

EntitiesSkillsUpdateV1

Update an existing skill with a new zip archive.

Method PUT

Route /agentic-studio/entities/skills/v1

Scope Charlotte AI Agent Definition: WRITE

PEP 8 update_studio_skill

Parameters

id body · string

ID of the skill to update

skill_blob body · file

Updated skill zip archive

file_name body · string

Name to use for the uploaded file.

Code Examples

Python

PEP 8

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.update_studio_skill(file_name="string",
                                      id="string",
                                      skill_blob="string")
print(response)

Operation ID

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.EntitiesSkillsUpdateV1(file_name="string",
                                         id="string",
                                         skill_blob="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("EntitiesSkillsUpdateV1",
                          id="string",
                          skill_blob="string")
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 Successfully updated

[
  {
    "attribution": {},
    "created_at": "string",
    "created_by": {},
    "description": "string",
    "id": "string",
    "is_deleted": false,
    "metadata": {},
    "name": "string",
    "updated_at": "string",
    "updated_by": {}
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

EntitiesSkillsV1

Retrieve skill entities for the provided IDs.

Method GET

Route /agentic-studio/entities/skills/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 get_studio_skills

Parameters

ids query · string or list of strings

IDs of skills to retrieve.

include_deleted query · boolean

Include deleted skills in the result. Defaults to false.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_studio_skills(ids=id_list, include_deleted=boolean)
print(response)

Operation ID

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.EntitiesSkillsV1(ids=id_list, include_deleted=boolean)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("EntitiesSkillsV1",
                          ids=id_list,
                          include_deleted=boolean)
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 Successfully retrieved

[
  {
    "attribution": {},
    "created_at": "string",
    "created_by": {},
    "description": "string",
    "id": "string",
    "is_deleted": false,
    "metadata": {},
    "name": "string",
    "updated_at": "string",
    "updated_by": {}
  }
]

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

QueriesSkillsV1

Query skills based on the provided filters.

Method GET

Route /agentic-studio/queries/skills/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 query_studio_skills

Parameters

offset query · integer

Starting index of overall result set from which to return ids.

limit query · integer

Number of IDs to return.

sort query · string

Possible order by fields: name. Ex: ‘name|asc’.

filter query · string

FQL query specifying the filter parameters.

include_deleted query · boolean

Include deleted skills in the result. Defaults to false.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.query_studio_skills(offset=integer,
                                      limit=integer,
                                      sort="string",
                                      filter="string",
                                      include_deleted=boolean)
print(response)

Operation ID

from falconpy import Skills

falcon = Skills(client_id=CLIENT_ID,
                client_secret=CLIENT_SECRET
                )

response = falcon.QueriesSkillsV1(offset=integer,
                                  limit=integer,
                                  sort="string",
                                  filter="string",
                                  include_deleted=boolean)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("QueriesSkillsV1",
                          offset=integer,
                          limit=integer,
                          sort="string",
                          filter="string",
                          include_deleted=boolean)
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 Successfully retrieved

[
  "string"
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}