Skip to main content

Add API Context

Woes answers developer questions from workspace-scoped source context. A source can be a formal API specification, a documentation site, raw Markdown, SDK examples, or a connected GitHub repository.

Supported Source Types

Source typeGood for
OpenAPIREST endpoints, auth schemes, schemas, request bodies, responses, and examples.
Postman documenterPublic Postman documentation pages and collection-style endpoint groups.
Raw documentation URLHosted API docs, guides, reference pages, and conceptual documentation.
Markdown or textInternal guides, SDK notes, support runbooks, and concise product behavior notes.
GraphQL schemaQuery/mutation types, fields, arguments, and schema descriptions.
AsyncAPIEvent, message, and webhook documentation.
SOAP or gRPC docsService operations, request/response contracts, and integration notes.
GitHub repositoryDocs, SDK examples, sample apps, README files, and source-adjacent API guidance.

Add a Source

1

Open Context

Go to Context in the workspace sidebar.
2

Choose the source type

Select the input path that best matches your material: URL, specification, raw docs, or GitHub repository.
3

Start ingestion

Woes scans the source, normalizes endpoint and document content, and builds retrieval chunks for the support agent.
4

Inspect the result

Open the source detail view to review endpoints, generated Markdown, documents, chunk coverage, auth readiness, and source health.
5

Attach the source to an agent

In Agents, attach the source to the right agent and run context learning.

Source Health

Woes shows status and coverage so operators can understand what the agent knows.
StateMeaning
ReadyThe source was scanned and has usable content.
PartialSome content was parsed, but one or more pages, documents, or endpoints need attention.
FailedWoes could not safely fetch or parse the source. Review the error and source accessibility.
No endpointsThe source may contain useful docs, but no endpoint-level reference was found.
Keep credentials separate from source content. Use source auth settings for test credentials instead of embedding secrets in documentation.