agent-swarm.devagent-swarm.dev

KV

Namespaced key-value store API — read, write, delete, list, and atomically increment KV entries for cross-task agent state

GET/api/kv

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

prefix?string
limit?integer
Range0 < value <= 1000
offset?|
Range0 <= value

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/kv"
{
  "entries": [
    {
      "namespace": "string",
      "key": "string",
      "value": null,
      "valueType": "json",
      "expiresAt": 0,
      "createdAt": 0,
      "updatedAt": 0
    }
  ],
  "total": 0,
  "namespace": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/kv/_/{namespace}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

namespace*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Query Parameters

prefix?string
limit?integer
Range0 < value <= 1000
offset?|
Range0 <= value

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/kv/_/string"
{
  "entries": [
    {
      "namespace": "string",
      "key": "string",
      "value": null,
      "valueType": "json",
      "expiresAt": 0,
      "createdAt": 0,
      "updatedAt": 0
    }
  ],
  "total": 0,
  "namespace": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE/api/kv/_/{namespace}/{key}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

namespace*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512
key*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Response Body

application/json

application/json

curl -X DELETE "http://localhost:3013/api/kv/_/string/string"
Empty
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/kv/_/{namespace}/{key}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

namespace*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512
key*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Query Parameters

path?string
Lengthlength <= 1024
offset?|
Range0 <= value
limit?integer
Range0 < value

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/kv/_/string/string"
{
  "namespace": "string",
  "key": "string",
  "value": null,
  "valueType": "json",
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0,
  "view": {
    "path": "string",
    "type": "object",
    "total": 0,
    "offset": 0,
    "returned": 0,
    "nextOffset": 0
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PUT/api/kv/_/{namespace}/{key}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

namespace*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512
key*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:3013/api/kv/_/string/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "namespace": "string",
  "key": "string",
  "value": null,
  "valueType": "json",
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST/api/kv/_/{namespace}/{key}/incr

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

namespace*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512
key*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

by?integer

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/kv/_/string/string/incr" \  -H "Content-Type: application/json" \  -d '{}'
{
  "namespace": "string",
  "key": "string",
  "value": null,
  "valueType": "json",
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE/api/kv/{key}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

key*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:3013/api/kv/string"
Empty
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET/api/kv/{key}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

key*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Query Parameters

path?string
Lengthlength <= 1024
offset?|
Range0 <= value
limit?integer
Range0 < value

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/kv/string"
{
  "namespace": "string",
  "key": "string",
  "value": null,
  "valueType": "json",
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0,
  "view": {
    "path": "string",
    "type": "object",
    "total": 0,
    "offset": 0,
    "returned": 0,
    "nextOffset": 0
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PUT/api/kv/{key}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

key*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:3013/api/kv/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "namespace": "string",
  "key": "string",
  "value": null,
  "valueType": "json",
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST/api/kv/{key}/incr

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

key*string
Match^[a-zA-Z0-9._:/%-]{1,512}$
Length1 <= length <= 512

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

by?integer

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/kv/string/incr" \  -H "Content-Type: application/json" \  -d '{}'
{
  "namespace": "string",
  "key": "string",
  "value": null,
  "valueType": "json",
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}