API Reference

This section provides detailed documentation for all SEDA FAST API endpoints. For interactive API exploration and testing, refer to the OpenAPI documentation links below:

Base URLs

SEDA FAST is available on the following networks:

Authentication

All API requests (except /health and /info) require authentication using a bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Your API key is provided during onboarding and is specific to your account. Keep it secure and never expose it in client-side code or public repositories.

Endpoints

SEDA FAST provides five core endpoints for executing Oracle Programs, managing your account, and monitoring service health. The primary endpoint is /execute, which handles all Oracle Program executions.

GET /execute

Execute an Oracle Program and return the result.

Required Parameters:

  • execProgramId - Oracle Program ID deployed on SEDA chain (hex string)

Optional Parameters:

  • execInputs / tallyInputs - Inputs for execution/tally phases (hex or UTF-8 string)

  • tallyProgramId - Separate tally program (defaults to execProgramId)

  • returnLastResul - Return cached result for ultra-low latency

  • includeSummary - Include credit usage details in response

  • includeDebugInfo - Include stdout/stderr for debugging

  • encoding - Output format for the result field: hex, base64, or utf8

Execute Request Example:

curl -X GET "<https://fast-api.seda.xyz/execute?execProgramId=85975ef3a54e8db6b017a75b4027e14277a1518337ec00e353c8e2bf6d2b4556&execInputs=54782d29>" \\
-H "Authorization: Bearer YOUR_API_KEY" \\
-H "Accept: application/json"

Response: Returns execution result with signature, gas usage, and exit code. Status 200 for success, 599 for failed execution (non-zero exit code).

GET /project

Retrieve your project configuration, including credits, limits, and allow-lists.

Parameters: None

Response: Current credit balance, usage limits, gas limits, and Oracle Program allow-list configuration.

GET /data-request-reports

Query historical execution reports for your project.

Parameters:

  • startDate / endDate - Filter by date range

  • amount - Number of reports to return (1-100, default: 25)

  • nextPageId - Pagination cursor

  • programId / execInputs - Filter by program or inputs

Response: Paginated list of past executions with results and metadata.

GET /info

Get SEDA FAST public key and version information.

Parameters: None

Authentication: Not required

Response: Public key (for signature verification) and API version.

GET /health

Health check endpoint for monitoring.

Parameters: None

Authentication: Not required

Response: Service status.

Error Codes

Status
Description

200

Success

400

Invalid or disallowed parameters

401

Invalid/missing API key

403

Insufficient credits

404

Oracle Program not found

429

Credit limit exceeded

500

Server error

599

Program execution failed (non-zero exit code)

Use query parameter include DebugInfo=true on /execute to get stdout/stderr for debugging failed executions.

Last updated

Was this helpful?