When you send a request on any service, you’ll get a response with 201 status code, this given response has a request_id which means your request has been created.
Here is an example of this kind of 201 response:
{
"data": {
"request_id": "*******"
},
"usage": {
"credits": 10
}
}
request_id
The request_id is the key identification to tracking your request status, you have to keep it to get actual response from the service on the next step.
credits
The credits is the amount of credits that this request has cost you and will pay from your account’s credits. You can see your credit balance on the MagicalAPI Panel.
Also, You can see the amount of credits needed for sending requests for each service on Pricing Page.
Send request with "request_id"
Now to get the actual response of service, you have to send a new request that includes the request_id that you have got from the previous response.
Important Note: It is better to send a request with request_id every 2 or 3 seconds to ensure the service will prepare the response for you.
Here is an example of sending a request with request_id (don’t forget to set the request authentication headers):
{
"request_id": "*******"
}
This was a general guide as the introduction of how to work with MagicalAPI API implementations and base configurations of the requests, You will learn more about each service with details in each service section.