Health and diagnostics

Whether the server is up, the Doctor’s readiness report, first-run state, and shutdown. Paths are relative to /api/v1.

POST /admin/shutdown

Shut the local server down gracefully.

Accepted only from the loopback address and only with the shutdown token in the x-talos-shutdown-token header; the token is compared in constant time. Answers 202 and stops on the next tick, so the answer leaves first. Without the right token: 401 and nothing stops.

Body

None: the body is empty.

Headers

x-talos-shutdown-token

Answers The JSON envelope.

Errors1

Code	Status	Meaning
AUTH_REQUIRED	401	This server accepts only the TALOS window that started it (or, for shutdown, the right token).

Any operation can also answer the common errors.

GET /sessions/{sessionId}/compaction-policy

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

sessionId

The session.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /sessions/{sessionId}/process-outputs/{processOutputId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

sessionId

The session.

processOutputId

Not yet described.

Answers The bytes themselves (a file or an image), not JSON.

GET /health

Check that the server is up: { "status": "ok" }.

Answers The JSON envelope.

Errors1

Code	Status	Meaning
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /setup/stato

The state of first-run setup: what is ready and what is still missing.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.
REPORT_UNAVAILABLE	404	The report or service asked for is not available on this server yet.

Any operation can also answer the common errors.

GET /doctor

Run the Doctor: the checks of this installation, with what to do for each problem.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.
REPORT_UNAVAILABLE	404	The report or service asked for is not available on this server yet.

Any operation can also answer the common errors.

GET /wsl

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.
WSL_STORE_UNAVAILABLE	503	—

Any operation can also answer the common errors.

POST /wsl

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Body

usaUtenteNormale

Not yet described.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.
WSL_STORE_UNAVAILABLE	503	—

Any operation can also answer the common errors.

GET /doctor/{reference}

The detail of a problem the Doctor recorded, by the reference shown on screen (doctor- and 12 hexadecimal digits).

Path

reference

The Doctor reference an error answered with (doctorReference).

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /me/notes

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

POST /me/notes

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Body

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /me/tasks

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

POST /me/tasks

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Body

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /me/memory

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

POST /me/memory

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Body

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /me/notes/{noteId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

noteId

The note.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

PATCH /me/notes/{noteId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

noteId

The note.

Body

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

DELETE /me/notes/{noteId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

noteId

The note.

Body

None: the body is empty.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /me/tasks/{taskId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

taskId

The task.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

PATCH /me/tasks/{taskId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

taskId

The task.

Body

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

DELETE /me/tasks/{taskId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

taskId

The task.

Body

None: the body is empty.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /me/memory/{memoryId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

memoryId

The memory.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

PATCH /me/memory/{memoryId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

memoryId

The memory.

Body

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

DELETE /me/memory/{memoryId}

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

memoryId

The memory.

Body

None: the body is empty.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

POST /me/tasks/{taskId}/stato

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

taskId

The task.

Body

statorequired

Not yet described.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

POST /me/notes/batch

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Body

azione

Not yet described.

ids

Not yet described.

Answers The JSON envelope.

Errors5

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.
RESEARCH_CONFLICT	409	The research run is not in the right state for this action.
RESEARCH_INVALID	400	The request is not valid for deep research.
RESEARCH_NOT_FOUND	404	The research run no longer exists.

Any operation can also answer the common errors.

POST /me/tasks/batch

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Body

azione

Not yet described.

ids

Not yet described.

Answers The JSON envelope.

Errors5

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.
RESEARCH_CONFLICT	409	The research run is not in the right state for this action.
RESEARCH_INVALID	400	The request is not valid for deep research.
RESEARCH_NOT_FOUND	404	The research run no longer exists.

Any operation can also answer the common errors.

POST /me/memory/batch

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Body

azione

Not yet described.

ids

Not yet described.

Answers The JSON envelope.

Errors5

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.
RESEARCH_CONFLICT	409	The research run is not in the right state for this action.
RESEARCH_INVALID	400	The request is not valid for deep research.
RESEARCH_NOT_FOUND	404	The research run no longer exists.

Any operation can also answer the common errors.

POST /sessions/{sessionId}/processes/{processeId}/stop

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

sessionId

The session.

processeId

Not yet described.

Body

None: the body is empty.

Answers The JSON envelope.

Errors3

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
PROCESS_NOT_RUNNING	409	—
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

POST /sessions/{sessionId}/processes/{processeId}/sfondo

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

sessionId

The session.

processeId

Not yet described.

Body

None: the body is empty.

Answers The JSON envelope.

Errors3

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
PROCESS_NOT_RUNNING	409	—
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

GET /sessions/{sessionId}/pending

Not yet described in this reference: the parameters, fields and errors below are read from the release.

Path

sessionId

The session.

Answers The JSON envelope.

Errors2

Code	Status	Meaning
NOT_FOUND	404	Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID	400	The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.