SDK Agents

Authenticate Sdk User

post

Authenticate SDK user and return API key.

This endpoint is called by ncp authenticate command.

Args: payload: Username and password db: Database session

Returns: API key and user information

Body

application/json

Request for SDK authentication.

usernamestringRequired

Username

passwordstringRequired

Password

Responses

200

Successful Response

application/json

Response for SDK authentication.

messagestringRequired

api_keystringRequired

JWT token for SDK API access

usernamestringRequired

first_nameany ofOptional

stringOptional

or

nullOptional

last_nameany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

post

/api/v1/sdk_agents/auth/login

HTTPcURLJavaScriptPython

POST /api/v1/sdk_agents/auth/login HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "username": "text",
  "password": "text"
}

{
  "message": "text",
  "api_key": "text",
  "username": "text",
  "first_name": "text",
  "last_name": "text"
}

Deploy Sdk Agent

post

Deploy an SDK agent from .ncp package.

This endpoint is called by ncp deploy command.

Args: file: .ncp package file (tar.gz) update: Optional agent name to update username: Authenticated username from API key db: Database session

Returns: Deployment status and agent information

Query parameters

updateany ofOptional

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

Body

multipart/form-data

filestringRequired

Responses

200

Successful Response

application/json

Response for agent deployment.

messagestringRequired

agent_idstringRequired

agent_namestringRequired

statusstring · enumRequired

Status of an SDK agent deployment.

Possible values:

422

Validation Error

application/json

post

/api/v1/sdk_agents/deploy

HTTPcURLJavaScriptPython

POST /api/v1/sdk_agents/deploy HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15

{
  "file": "text"
}

{
  "message": "text",
  "agent_id": "text",
  "agent_name": "text",
  "status": "PENDING"
}

List Sdk Agents

get

List SDK agents deployed by the authenticated user.

Args: username: Authenticated username db: Database session

Returns: List of user's SDK agents

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response for listing agents.

totalintegerRequired

422

Validation Error

application/json

get

/api/v1/sdk_agents/list

HTTPcURLJavaScriptPython

GET /api/v1/sdk_agents/list HTTP/1.1
Accept: */*

{
  "agents": [
    {
      "agent_id": "text",
      "name": "text",
      "description": "text",
      "status": "PENDING",
      "version": "text",
      "deployed_by": "text",
      "deployed_at": "2026-04-02T10:49:35.911Z",
      "updated_at": "2026-04-02T10:49:35.911Z",
      "error_message": "text"
    }
  ],
  "total": 1
}

Remove Sdk Agent

delete

Remove an SDK agent.

This endpoint is called by ncp remove command.

Args: agent_name: Name of the agent username: Authenticated username db: Database session

Returns: Removal confirmation

Path parameters

agent_namestringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response for agent removal.

messagestringRequired

agent_namestringRequired

422

Validation Error

application/json

delete

/api/v1/sdk_agents/remove/{agent_name}

HTTPcURLJavaScriptPython

DELETE /api/v1/sdk_agents/remove/{agent_name} HTTP/1.1
Accept: */*

{
  "message": "text",
  "agent_name": "text"
}

Get Available Agents

get

Get list of available SDK agents for UI dropdown.

Returns only deployed agents owned by the authenticated user.

Args: username: Authenticated username db: Database session

Returns: List of available agents with basic information

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/v1/sdk_agents/available

HTTPcURLJavaScriptPython

GET /api/v1/sdk_agents/available HTTP/1.1
Accept: */*

No content