SDK Agents
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
Request for SDK authentication.
Username
Password
Successful Response
Response for SDK authentication.
JWT token for SDK API access
Validation Error
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 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
Successful Response
Response for agent deployment.
Status of an SDK agent deployment.
Validation Error
POST /api/v1/sdk_agents/deploy HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}{
"message": "text",
"agent_id": "text",
"agent_name": "text",
"status": "PENDING"
}List SDK agents deployed by the authenticated user.
Args: username: Authenticated username db: Database session
Returns: List of user's SDK agents
Successful Response
Response for listing agents.
Validation Error
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-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"error_message": "text"
}
],
"total": 1
}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
Successful Response
Response for agent removal.
Validation Error
DELETE /api/v1/sdk_agents/remove/{agent_name} HTTP/1.1
Accept: */*
{
"message": "text",
"agent_name": "text"
}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
Successful Response
Validation Error
GET /api/v1/sdk_agents/available HTTP/1.1
Accept: */*
No content
Last updated
