Skip to main content
SONZAI
Api

Constellation

Get agent constellation graph

GET
/agents/{agentId}/constellation
AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

Agent UUID or URL-encoded agent name

Query Parameters

user_id?string

Optional user ID to scope nodes and insights

Response Body

application/json

application/problem+json

curl -X GET "https://loading/api/v1/agents/string/constellation"
{
  "$schema": "/api/v1/schemas/ConstellationResponse.json",
  "edges": [
    {
      "AgentID": "string",
      "CoOccurrenceCount": 0,
      "CreatedAt": "2019-08-24T14:15:22Z",
      "EdgeID": "string",
      "EdgeType": "string",
      "FromNodeID": "string",
      "Strength": 0.1,
      "ToNodeID": "string",
      "UpdatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "insights": [
    {
      "AgentID": "string",
      "Confidence": 0.1,
      "Content": "string",
      "CreatedAt": "2019-08-24T14:15:22Z",
      "InsightID": "string",
      "InsightType": "string",
      "Priority": 0,
      "RelatedNodes": [
        "string"
      ],
      "Surfaced": true,
      "UpdatedAt": "2019-08-24T14:15:22Z",
      "UserID": "string"
    }
  ],
  "nodes": [
    {
      "$schema": "/api/v1/schemas/Node.json",
      "AgentID": "string",
      "Brightness": 0.1,
      "CreatedAt": "2019-08-24T14:15:22Z",
      "Description": "string",
      "FirstMentionedAt": "2019-08-24T14:15:22Z",
      "Label": "string",
      "LastMentionedAt": "2019-08-24T14:15:22Z",
      "MentionCount": 0,
      "NodeID": "string",
      "NodeType": "string",
      "Significance": 0.1,
      "UpdatedAt": "2019-08-24T14:15:22Z",
      "UserID": "string"
    }
  ]
}
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Create a constellation node

POST
/agents/{agentId}/constellation/nodes
AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

Agent UUID or URL-encoded agent name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

curl -X POST "https://loading/api/v1/agents/string/constellation/nodes" \  -H "Content-Type: application/json" \  -d '{    "label": "string"  }'
{
  "$schema": "/api/v1/schemas/Node.json",
  "AgentID": "string",
  "Brightness": 0.1,
  "CreatedAt": "2019-08-24T14:15:22Z",
  "Description": "string",
  "FirstMentionedAt": "2019-08-24T14:15:22Z",
  "Label": "string",
  "LastMentionedAt": "2019-08-24T14:15:22Z",
  "MentionCount": 0,
  "NodeID": "string",
  "NodeType": "string",
  "Significance": 0.1,
  "UpdatedAt": "2019-08-24T14:15:22Z",
  "UserID": "string"
}
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Delete a constellation node

DELETE
/agents/{agentId}/constellation/nodes/{nodeId}
AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

Agent UUID or URL-encoded agent name

nodeId*string

Constellation node ID

Response Body

application/problem+json

curl -X DELETE "https://loading/api/v1/agents/string/constellation/nodes/string"
Empty
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Update a constellation node

PUT
/agents/{agentId}/constellation/nodes/{nodeId}
AuthorizationBearer <token>

API key issued to a Sonzai project. Format: Bearer sk_....

In: header

Path Parameters

agentId*string

Agent UUID or URL-encoded agent name

nodeId*string

Constellation node ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

curl -X PUT "https://loading/api/v1/agents/string/constellation/nodes/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "$schema": "/api/v1/schemas/Node.json",
  "AgentID": "string",
  "Brightness": 0.1,
  "CreatedAt": "2019-08-24T14:15:22Z",
  "Description": "string",
  "FirstMentionedAt": "2019-08-24T14:15:22Z",
  "Label": "string",
  "LastMentionedAt": "2019-08-24T14:15:22Z",
  "MentionCount": 0,
  "NodeID": "string",
  "NodeType": "string",
  "Significance": 0.1,
  "UpdatedAt": "2019-08-24T14:15:22Z",
  "UserID": "string"
}
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}