Gets an accessible skill.

GET

https://api.awork.com/api/v1/agents/skills/:skillId

GET

/api/v1/agents/skills/:skillId

curl https://api.awork.com/api/v1/agents/skills/skillId \
     -H "Authorization: Bearer <token>"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2024-01-15T09:30:00Z",
  "updatedOn": "2024-01-15T09:30:00Z",
  "key": "string",
  "name": "string",
  "description": "string",
  "instructions": "string",
  "instructionsSource": "string",
  "type": "user",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "agentId": "123e4567-e89b-12d3-a456-426614174000",
  "accessLevel": "read",
  "isOwner": true,
  "workspaceAccessLevel": "read",
  "linkedAgentCount": 1,
  "metadata": "string",
  "hasFiles": true,
  "secretRequirements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "envVarName": "string",
      "description": "string",
      "scope": "workspace",
      "isRequired": true,
      "hasValue": true
    }
  ]
}

Returns one skill when the caller has read access directly or through the optional linked agent.

Required Permissions

Any authenticated user.

Returns one skill when the caller has read access directly or through the optional linked agent. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

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

Path parameters

skillIdstringRequiredformat: "uuid"

The skill ID.

Query parameters

agentIdstringOptionalformat: "uuid"

The optional linked agent through which read access is requested.

Response

idstringOptionalformat: "uuid"

The skill identifier.

createdBystringOptionalformat: "uuid"

The user who created the skill.

createdOnstringOptionalformat: "date-time"

When the skill was created.

updatedOnstring or nullOptionalformat: "date-time"

When the skill was last updated.

keystring or nullOptional

The stable key used to reference the skill.

namestring or nullOptional

The name shown in the skill library.

descriptionstring or nullOptional

A short explanation of what the skill does.

instructionsstring or nullOptional

The Markdown instruction body from SKILL.md.

instructionsSourcestring or nullOptional

The source from which the instructions were created.

typeenumOptional

The ownership type.

userIdstring or nullOptionalformat: "uuid"

The owning user for a user-owned skill.

agentIdstring or nullOptionalformat: "uuid"

The owning agent for an agent-owned skill.

accessLevelenumOptional

The requesting user's resolved access level.

isOwnerbooleanOptional

Whether the requesting user owns the skill.

workspaceAccessLevelenum or nullOptional

The workspace-wide access level.

linkedAgentCountintegerOptional

The number of linked agents.

metadatastring or nullOptional

The skill frontmatter as a JSON object.

hasFilesbooleanOptional

Whether the skill includes bundled files.

secretRequirementslist of objects or nullOptional

The secrets that the skill declares.

Errors

401

Unauthorized Error

404

Not Found Error