Dendric
Ask or search…
K
⚙️

API Reference

OpenFXS API Documentation

Introduction

Welcome to the OpenFXS API documentation! Our API provides a straightforward way to harness the power of our creative AI models. By following this guide, you'll learn how to submit tasks, check their status, and retrieve the generated data.

Base URL

All API requests should be made to the following base URL:
https://api.openfxs.com/v1

1. Submitting a Task

Endpoint

POST /task

Request Parameters

  • query (string): The input text prompt for generating creative content.
  • api-key (string): Your unique API key for authentication.

Example Request

curl -X POST "https://api.openfxs.com/v1/task" \
-H "Content-Type: application/json" \
-d '{"query": "Your text prompt here", "api-key": "Your_API_Key"}'

Response

Upon successful submission, you will receive a JSON response containing a task_id.
{
"task_id": "your_task_id"
}

2. Checking Task Status and Retrieving Data

Endpoint

GET /task/status

Request Parameters

  • task_id (string): The unique identifier for the submitted task.

Example Request

curl -X GET "https://api.openfxs.com/v1/task/status?task_id=your_task_id" \
-H "Content-Type: application/json" \
-H "api-key: Your_API_Key"

Response

The response will include the status of the task and, once complete, the generated data.
{
"status": "completed",
"data": {
// Your generated content here
}
}

Conclusion

Congratulations! You've successfully integrated with the OpenFXS API. For any issues or inquiries, please contact our support team at [email protected]. Happy creating!
Last modified 1mo ago