Protocols and contracts

These pages define rules shared by multiple SDK methods and REST endpoints. Use them when you need the exact wire behavior or data contract rather than one operation's signature.

Contract

SDK and REST pages own individual operations. This section owns the contracts those operations reuse.

Streaming protocol

Choose the correct stream, headers, consumption model, and failure handling.

Objects and schemas

Look up public resource shapes, mutability, nullability, and status values.

Errors

Handle REST envelopes, SDK errors, and failures after streaming begins.

Resource IDs

Recognize public ID formats while treating identifiers as opaque values.

Pagination and filtering

Traverse keyset pages, poll transcripts, and apply resource-specific filters.

Service limits

Design around enforced resource, payload, query, and execution bounds.

Examples

An SDK stream uses the streaming contract and the shared error contract:

const result = await client.completion({ agentId, prompt: "Summarize this." });

for await (const delta of result.textStream) {
  process.stdout.write(delta);
}

A REST list operation combines IDs, pagination, returned objects, errors, and limits:

curl "$BLAZING_AGENTS_BASE_URL/v1/agents/$AGENT_ID/sessions?limit=50" \
  -H "Authorization: Bearer $BLAZING_AGENTS_API_KEY"

Used by

Source of truth

packages/sdk/src/index.ts
packages/sdk/src/client.ts
packages/sdk/src/types.ts
servers/api/src/routes/index.ts
packages/core/src/api.ts
packages/core/src/entities/agents.ts
packages/core/src/entities/apikeys.ts
packages/core/src/entities/artifacts.ts
packages/core/src/entities/attribution.ts
packages/core/src/entities/chat.ts
packages/core/src/entities/mcp-connections.ts
packages/core/src/entities/memories.ts
packages/core/src/entities/prompts.ts
packages/core/src/entities/providers.ts
packages/core/src/entities/sandboxes.ts
packages/core/src/entities/sessions.ts
packages/core/src/entities/skills.ts
packages/core/src/entities/tasks.ts
packages/core/src/entities/tenants.ts
packages/core/src/entities/usage.ts
packages/sdk/src/index.test.ts
servers/api/src/app.test.ts

See the capability and guide links under Used by.

Reference

See the implementation inventory under Source of truth.