Felo API PlatformFelo API Platform

データ API / Exa / Agent

Submit an asynchronous research Agent run.

Submit an asynchronous research task. query and Idempotency-Key are required. Configure effort, outputSchema, dataSources and previousRunId as needed. HTTP 202 returns a job; poll get_exa_agent_run until completed, failed or cancelled. Completed output contains text, structured data and grounding. Reusing an Idempotency-Key returns the existing job. Job pricing fields are provider metadata, not Felo billing records.

パラメータ

ヘッダー

  • Idempotency-Keystring必須

    Unique key (1 to 191 characters) that makes the submit idempotent. Re-submitting with the same key and request fingerprint returns the original run.

リクエストボディ

  • querystring必須

    The natural-language research query.

  • outputSchemaobject任意

    JSON Schema used to validate the structured output.

  • inputobject任意

    Row-processing input: rows to process and exclusions.

  • dataarray任意

    Input rows for the run.

  • exclusion任意

    Items to exclude from processing.

  • effortstring任意

    Compute/depth tier for the run.

  • previousRunIdstring任意

    Continue from a previously completed run.

  • dataSourcesarray任意

    Third-party data sources (Exa Connect) the Agent is granted access to.

リクエスト例

curl -X POST "https://openapi.felo.ai/v1/beta/exa/agent/runs" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Idempotency-Key: <string>" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "<string>",
  "outputSchema": {},
  "input": {},
  "effort": "<string>",
  "previousRunId": "<string>",
  "dataSources": "<string>"
}'

レスポンス

レスポンスのフィールド

  • idstring任意

    Job identifier. Use it with the corresponding Felo polling endpoint.

  • objectstring任意

    Always "integration_async_job".

  • endpointstring任意

    Provider operation identifier stored with the job. This metadata is not a Felo polling URL; use the documented Felo job path or Location header.

  • statusstring任意

    指定できる値: queued · running · completed · failed · cancelled

    Customer-facing lifecycle status. queued and running are non-terminal; completed, failed, and cancelled are terminal.

  • createdAtstring任意

    When the job was accepted.

  • completedAt任意

    When the job reached a terminal status. Null while the job is still queued or running.

  • pricingobject任意
  • currencystring任意
  • authorizedMicrosUSDinteger任意

    Provider authorization metadata in micro-USD. This is not a Felo credit hold or billing record.

  • finalMicrosUSD任意

    Provider settlement metadata in micro-USD, nullable before settlement. This is not the Felo charge.

  • billingModestring任意

    Provider job billing mode. Felo charges follow Felo billing records.

  • output任意

    Job result payload. Present only once status is completed. For Agent Runs this is the structured research result.

  • outputExpiredboolean任意

    True when the result has been retained past its retention window and is no longer retrievable.

  • error任意

    Present when status is failed. Null otherwise.