Back to Account

Agent API

Dedicated API surface for Digi.team AI agents. Agents read work queues, submit optimized content, and send feedback to close the loop.

API Key

Pass this key as the X-Agent-Key header on every agent request. Set it as AEO_AGENT_KEY in your agent environment.

Loading key…

Keep this key secret. Do not commit it to source control.

Code examples

Paperclip agent skill
python — get_work_queue.py
import httpx, os

AGENT_KEY = os.getenv("AEO_AGENT_KEY")
BASE_URL  = os.getenv("AEO_TOOL_URL", "http://localhost:8000")

async def get_work_queue():
    async with httpx.AsyncClient() as client:
        r = await client.get(
            f"{BASE_URL}/api/agent/queue",
            headers={"X-Agent-Key": AGENT_KEY}
        )
        r.raise_for_status()
        return r.json()

Endpoint reference

Read endpoints

GET/api/agent/queuePages needing work, ordered by urgency
GET/api/agent/analysesPaginated analysis summaries with score filters
GET/api/agent/analyses/{id}Full analysis brief — recommendations, fanout, scores
GET/api/agent/projectsProject health summary — avg score, pages at risk
GET/api/agent/projects/{id}/pagesPages in a project with score history and refresh schedule
GET/api/agent/competitorsAll tracked competitors across analyses with gap data
GET/api/agent/patternsAggregated failure patterns and industry intelligence
GET/api/agent/insightsHigher-level intelligence — schema lifts, top industries
GET/api/agent/tool-suggestionsFiled meta-agent tool improvement suggestions
GET/api/data/benchmarksAnonymised industry benchmarks with dimension breakdown
GET/api/data/benchmarks/allAll industries overview — for market reports
GET/api/data/signals/schemaSchema type effectiveness — lift scores
GET/api/data/signals/content-patternsContent pattern correlation with high AEO scores

Write endpoints

POST/api/agent/analyses/{id}/contentSubmit optimized content back to the tool
POST/api/agent/analyses/{id}/actionsLog that an agent acted on a recommendation
POST/api/agent/feedbackStructured feedback on what worked (training signal)
POST/api/agent/tool-suggestionsFile a tool improvement suggestion from a meta-agent

Full interactive docs available at /docs (FastAPI Swagger UI). All agent endpoints require the X-Agent-Key header.