API introduction

​

Base URL

https://api.up2data.ai

​

Authentication

​

The envelope

{
  "data": { },
  "meta": {
    "creditsUsed": 1,
    "creditsRemaining": 98420,
    "billed": true,
    "reason": "profile_found",
    "requestId": "req_8f2ka91x",
    "latencyMs": 3400
  }
}

{
  "error": { "type": "unprocessable_target", "message": "…", "requestId": "req_…" }
}

​

Conventions

• Credit badge — every endpoint page states its cost at the top. Costs are also machine-readable as x-credits in the OpenAPI spec.
• Real-time — enrichment endpoints scrape at request time. Typical latency is 2–8s for a single entity; use batch for volume.
• Pay-on-success — failed scrapes are never billed. Exact rules per outcome: Pay-on-success.
• Pagination — list endpoints (/v1/triggers, /v1/signals) use cursor pagination: pass cursor from the previous response’s meta.nextCursor.
• Idempotency — batch submissions accept an Idempotency-Key header.

​

Machine-readable

• OpenAPI 3.1: https://docs.up2data.ai/openapi.yaml
• Postman: import the OpenAPI URL directly
• llms.txt: https://docs.up2data.ai/llms.txt