Agent API

Reference for the local Toolang agent HTTP API.

Base URL for a running local agent is http://127.0.0.1:<port> unless the agent is started with a different host or port.

Endpoints

Agent

Agent profile and health endpoints.

Get Profile

GET /api/v1/profile

Responses:

Health Check

GET /healthz

Responses:

Chat

Chat submission and streaming endpoints.

List Chat Models

GET /api/v1/chat/models

Responses:

Submit Chat

POST /api/v1/chat

Request body:

Responses:

Submit Chat Stream

POST /api/v1/chat/stream

Request body:

Responses:

Caps

Capability inspection and mutation endpoints.

Get Caps Summary

GET /api/v1/caps

Responses:

List Prompts

GET /api/v1/prompts

Responses:

List Prompt Templates

GET /api/v1/prompts/templates

Responses:

Get Prompt Template

GET /api/v1/prompts/templates/{template_name}

Parameters:

Responses:

Get Prompt

GET /api/v1/prompts/{name}

Parameters:

Responses:

List Psyches

GET /api/v1/psyches

Responses:

List Psyche Templates

GET /api/v1/psyches/templates

Responses:

Get Psyche Template

GET /api/v1/psyches/templates/{template_name}

Parameters:

Responses:

Get Psyche

GET /api/v1/psyches/{name}

Parameters:

Responses:

List Services

GET /api/v1/services

Responses:

List Service Templates

GET /api/v1/services/templates

Responses:

Get Service Template

GET /api/v1/services/templates/{template_name}

Parameters:

Responses:

Get Service

GET /api/v1/services/{name}

Parameters:

Responses:

List Skills

GET /api/v1/skills

Responses:

List Skill Templates

GET /api/v1/skills/templates

Responses:

Get Skill Template

GET /api/v1/skills/templates/{template_name}

Parameters:

Responses:

Get Skill

GET /api/v1/skills/{name}

Parameters:

Responses:

Upsert File Prompt

PUT /api/v1/prompts/{name}/file

Parameters:

Request body:

Responses:

Wire Prompt

PUT /api/v1/prompts/{name}/wired

Parameters:

Request body:

Responses:

Upsert File Psyche

PUT /api/v1/psyches/{name}/file

Parameters:

Request body:

Responses:

Wire Psyche

PUT /api/v1/psyches/{name}/wired

Parameters:

Request body:

Responses:

Upsert File Service

PUT /api/v1/services/{name}/file

Parameters:

Request body:

Responses:

Wire Service

PUT /api/v1/services/{name}/wired

Parameters:

Request body:

Responses:

Upsert File Skill

PUT /api/v1/skills/{name}/file

Parameters:

Request body:

Responses:

Wire Skill

PUT /api/v1/skills/{name}/wired

Parameters:

Request body:

Responses:

Delete File Prompt

DELETE /api/v1/prompts/{name}/file

Parameters:

Responses:

Unwire Prompt

DELETE /api/v1/prompts/{name}/wired

Parameters:

Responses:

Delete File Psyche

DELETE /api/v1/psyches/{name}/file

Parameters:

Responses:

Unwire Psyche

DELETE /api/v1/psyches/{name}/wired

Parameters:

Responses:

Delete File Service

DELETE /api/v1/services/{name}/file

Parameters:

Responses:

Unwire Service

DELETE /api/v1/services/{name}/wired

Parameters:

Responses:

Delete File Skill

DELETE /api/v1/skills/{name}/file

Parameters:

Responses:

Unwire Skill

DELETE /api/v1/skills/{name}/wired

Parameters:

Responses:

Jobs

Task, chore, and will inspection endpoints.

List Chores

GET /api/v1/chores

Responses:

List Archived Chores

GET /api/v1/chores/archived

Responses:

Get Archived Chore

GET /api/v1/chores/archived/{chore_id}

Parameters:

Responses:

Get Chore

GET /api/v1/chores/{chore_id}

Parameters:

Responses:

List Jobs

GET /api/v1/jobs

Parameters:

Responses:

List Archived Jobs

GET /api/v1/jobs/archived

Parameters:

Responses:

Get Archived Job

GET /api/v1/jobs/archived/{job_id}

Parameters:

Responses:

Get Job

GET /api/v1/jobs/{job_id}

Parameters:

Responses:

List Tasks

GET /api/v1/tasks

Responses:

List Archived Tasks

GET /api/v1/tasks/archived

Responses:

Get Archived Task

GET /api/v1/tasks/archived/{task_id}

Parameters:

Responses:

Get Task

GET /api/v1/tasks/{task_id}

Parameters:

Responses:

Get Will

GET /api/v1/will

Responses:

Create Chore

POST /api/v1/chores

Request body:

Responses:

Create Task

POST /api/v1/tasks

Request body:

Responses:

Delete Archived Chore

DELETE /api/v1/chores/archived/{chore_id}

Parameters:

Responses:

Delete Archived Job

DELETE /api/v1/jobs/archived/{job_id}

Parameters:

Responses:

Delete Archived Task

DELETE /api/v1/tasks/archived/{task_id}

Parameters:

Responses:

Update Archived Chore

PATCH /api/v1/chores/archived/{chore_id}

Parameters:

Request body:

Responses:

Update Chore

PATCH /api/v1/chores/{chore_id}

Parameters:

Request body:

Responses:

Update Archived Job

PATCH /api/v1/jobs/archived/{job_id}

Parameters:

Request body:

Responses:

Update Job

PATCH /api/v1/jobs/{job_id}

Parameters:

Request body:

Responses:

Update Archived Task

PATCH /api/v1/tasks/archived/{task_id}

Parameters:

Request body:

Responses:

Update Task

PATCH /api/v1/tasks/{task_id}

Parameters:

Request body:

Responses:

Activity

Thread, run, and event history endpoints.

List Agent Events

GET /api/v1/agent/events

Parameters:

Responses:

Stream Agent Events

GET /api/v1/agent/stream

Parameters:

Responses:

Get Context Prompt

GET /api/v1/context/{prompt_hash}

Parameters:

Responses:

List Events

GET /api/v1/events

Parameters:

Responses:

Stream Events

GET /api/v1/events/stream

Responses:

Get Instruct Prompt

GET /api/v1/instruct/{prompt_hash}

Parameters:

Responses:

List Runs

GET /api/v1/runs

Parameters:

Responses:

Get Run

GET /api/v1/runs/{run_id}

Parameters:

Responses:

List Run Events

GET /api/v1/runs/{run_id}/events

Parameters:

Responses:

Stream Run Events

GET /api/v1/runs/{run_id}/stream

Parameters:

Responses:

List Threads

GET /api/v1/threads

Parameters:

Responses:

Get Thread

GET /api/v1/threads/{thread_id}

Parameters:

Responses:

List Thread Events

GET /api/v1/threads/{thread_id}/events

Parameters:

Responses:

Stream Thread Events

GET /api/v1/threads/{thread_id}/stream

Parameters:

Responses:

Restart Run

POST /api/v1/runs/{run_id}/restart

Parameters:

Request body:

Responses:

Steer Run

POST /api/v1/runs/{run_id}/steer

Parameters:

Request body:

Responses:

Stop Run

POST /api/v1/runs/{run_id}/stop

Parameters:

Request body:

Responses:

Schemas

ChatMessagePayload

One structured chat message payload.

ChatRequest

One formal chat submission.

ChoreCreateRequest

ChorePatchRequest

JobPatchRequest

PutCapRequest

One authored cap write request.

RunCancelRequest

Request run cancellation.

RunInputMessagePayload

One user-authored run input message.

RunRestartRequest

Request one restarted chat run with a replacement input.

RunSteerRequest

Request one steering message for a running run.

TaskCreateRequest

TaskPatchRequest

ThreadPeerPayload

One optional chat thread peer descriptor.

WiredCapRequest

One wired cap ref mutation request.

HTTPValidationError

ValidationError