Skip to main content
Every endpoint of the Starleads public API is documented in this section, grouped by resource.
Base URL: https://api.starleads.co — every request requires the X-Api-Key header.

​
Where to start

Most integrations only need the campaign endpoints: create a campaign, push your prospects into it, then receive the results via webhook.

Campaigns

List and create the campaigns your AI agents run.

Campaign Items

Add, retrieve and remove the prospects of a campaign.

Campaign Fields

Read the custom fields expected in an item’s databag.

Agents

Read and update an agent’s prompt, and connect it to a knowledge base.

​
Knowledge base (RAG)

Optional. Use these endpoints only if you want your agents to answer from your own documents. Start with the Knowledge Base guide rather than the raw endpoints — the objects have to be created in order.

Datasets

Containers holding the documents your agents draw answers from.

Documents

Upload, parse and manage the files inside a dataset.

Knowledge Base Chats

The retrieval configuration an agent is connected to.

Knowledge Graph

Extract entities and relations from a dataset.

​
Conventions

Authentication — pass your key in the X-Api-Key header on every call. See the Authentication guide to retrieve it. Pagination — list endpoints accept pageNumber (starts at 1) and pageSize (1 to 100, default 50). Responses carry data, total, pageNumber and pageSize. Errors — failures return an RFC 7807 problem object.
A resource owned by another company answers 404, not 403, so the API never discloses that it exists.
Rate limiting — responses carry X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Heavy operations (uploads, parsing, knowledge graph builds) have tighter limits than plain CRUD calls.