Skip to main content
POST
cURL
🚧 Coming Soon
The Messages API is currently being updated to support the new report-focused approach. Check back soon for the latest endpoints.

Overview

The messages endpoint allows you to submit natural language queries about blockchain data. The API processes messages asynchronously, providing a more robust way to handle longer-running queries.

Request Flow

  1. Submit your query using the /v1/messages endpoint
  2. Receive a processingId to track your request
  3. Poll the /v1/messages/{processingId}/status endpoint to get the final result

Examples

Submitting a Query

Checking Status and Getting Results

Response Statuses

The status endpoint can return the following statuses:
  • PENDING: The message has been received and is waiting to be processed
  • PROCESSING: The message is currently being processed
  • FINISHED: Processing is complete and the result is available
  • ERROR: An error occurred during processing

Error Handling

When an error occurs, the status response will include an errorMessage field with details about what went wrong. Common error scenarios include:
  • Invalid API key
  • Malformed query
  • Processing timeout
  • Internal server errors

Best Practices

  1. Always implement proper error handling and retry logic
  2. Use appropriate polling intervals (2-3 seconds recommended)
  3. Set reasonable timeouts for your application
  4. Store the processingId for later reference if needed
  5. Consider implementing a webhook system for production applications

Authorizations

x-api-key
string
header
required

Body

application/json
prompt
string
required

A natural language query about cryptocurrency prices

Example:

"Get the current price of ETH"

Response

Message submitted for processing

processingId
string
required

Unique identifier for tracking the message processing status

Example:

"123e4567-e89b-12d3-a456-426614174000"

status
enum<string>
required

Initial status of the request

Available options:
PENDING