API Sources

API Sources let an organization ingest records from a read-only API operation when the tool is not available as a connector.

Create and manage API sources from the organization dashboard under Integrations > API Sources.

When to use an API source

Use an API source when a system exposes useful records through an API, but does not have a first-class connector in the catalog.

API sources are best for pull-based data: tickets, accounts, documents, tasks, cases, orders, usage records, or other structured records that should become available to Achiral memory.

Create a source

Select New API source, then provide:

Source name: a human-readable name for the source.
API service: the stable service identifier, such as billing-api, support-api, or another internal service key.
Read operation: the read-only operation or workflow Achiral should call.
Credential reference: the stored credential Achiral should use for the API call.
Memory event type: the event label assigned to records from this source.

Use Preview records before creating the source when you want to confirm the operation returns the expected shape.

Advanced request settings

Advanced settings expose lower-level request controls:

API gateway URL: an optional gateway override for the API call.
Request parameters: JSON parameters sent with the read operation.

Keep advanced settings minimal. Most sources should only need the service, operation, credential reference, and memory event type.

Operations

API sources can be paused, resumed, or archived from the API Sources tab.

Active sources are available for ingestion.
Paused sources remain configured but do not run scheduled ingestion work.
Archived sources are retired and should not be used for new ingestion.

Troubleshooting

If preview or ingestion fails:

Confirm the read operation exists and is read-only.
Confirm the credential reference points to a valid stored credential.
Confirm request parameters are valid JSON.
Check whether API ingestion is currently enabled by an administrator.

Connectors — authorize popular apps and tools.
Webhooks — receive signed events from external systems.
Organization — manage organization settings and access.