Sources
The Sources API lets backend systems manage the API context that Woes uses for
grounded answers. Use it to ingest OpenAPI specs, documentation URLs, pasted
reference text, GraphQL schemas, Postman sources, AsyncAPI, gRPC, SOAP, GitHub
context, and other supported source types.
Source endpoints can change what the support agent knows. Use a scoped key
with sources:write, keep ingestion jobs server-side, and review source
coverage after large imports.
Supported Source Types
The REST Sources API directly creates these source types:
auto, openapi, json, url, website, text, graphql, postman,
asyncapi, grpc, soap, and github.
Use auto when you want Woes to detect the source shape. Use a specific type
when your pipeline already knows what it is sending.
Connector-created sources, such as Notion pages and Confluence spaces, appear
in source list and detail responses after they are imported from their
integration flows. HubSpot CRM context can also appear as an operator-only
source after it is synced from the HubSpot integration.
Create a Source
Provide either a url or content.
The response includes the created source plus counts for extracted documents,
endpoints, and chunks.
If the workspace has reached its effective API source capacity, creation returns
a capacity error instead of silently importing a partial source. Increase plan
capacity or remove unused sources before retrying.
Read Source Details
Source details include redacted endpoint and document content. Woes removes
values that look like credentials before returning them.
Publish Public Docs
Use PATCH /api/v1/sources/{sourceId} to rename a source or update its public
docs publication state.
Only ready sources can be published. Published docs are served from a sanitized
public slug and omit source credentials, workspace secrets, service-role data,
and raw private metadata.
Rescan
Rescan works for URL-backed sources. Pasted/manual sources are not rescannable;
create a new source when the source content lives only in the request body.
Source Statuses
API source statuses are pending, processing, ready, and failed.
Coverage gaps or warnings can still exist on a ready source, but partial is
not a persisted source status.
Delete
Deleting a source removes it from the workspace and marks default-agent context
stale so it can resync.
Required Scopes
Use the generated Sources endpoint pages for exact request bodies, examples,
and runnable calls.
