SCscaleapi
Agent APIKeys

Create Api Key

Changed on
post/agent_api_keys

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

agent_idstring nullable

The UUID of the agent

agent_namestring nullable

The name of the agent - if not provided, the agent_id must be set.

namestring required

The name of the agent's API key.

api_key_type'internal' | 'external' | 'github' | 'slack' | 'linear'
api_keystring nullable

Optionally provide the API key value - if not set, one will be generated.

Response

Successful Response

idstring required

The unique identifier of the agent API key.

agent_idstring required

The UUID of the agent

created_atstring date-time required

When the agent API key was created

namestring nullable required

The optional name of the agent API key.

api_key_type'internal' | 'external' | 'github' | 'slack' | 'linear' required
api_keystring required

The value of the newly created API key.

Changes

  • 9ebff612ab56Revision changes
    • warning

      added the new linear enum value to the response property for the response status

    • info

      added the new linear enum value to the request property