API response
The API response is the data received from the server as a result of the requested Cocktail operation
The response may include the success of the requested task, data, error messages, etc
Below is an example of a simple JSON-formatted API response.
Response for successful task completion.
code
string
Internal Response Status Codes
Successful case: 200
result
The type varies depending on the requested task
Contents of the query
status
string
Internal response status
You can determine the success of the task based on the status.
code
string
Value: ""
message
string
Value: ""
metadata
string
Value: null
result
The type varies depending on the requested task
Contents of the query
status
string
Internal response status
Value: "ok"
Response for failed task execution
code
string
Internal Response Status Code
message
string
Internal Response Status Message
status
string
Internal Response Status
API REFERENCE
The API REFERENCE document below contains only the content regarding the "result" value in case of successful task execution.
Last updated
Was this helpful?