Kinetix SDK API 1.4.45
OAS3
Authentication
In order to call these APIs, you will need an API key. Set the API key in the header x-api-key:
x-api-key: xxxxxxxxxxxxxxxxxxxx
HTTP Codes
The APIs will return the following HTTP codes:
| Code | Description |
|---|---|
| 200 (OK) | Request processed successfully. The response is different for each API, please refer to the operation's documentation |
| 201 (Created) | Request processed successfully. The response is different for each API, please refer to the operation's documentation |
| 204 (No Content) | Request processed successfully. The response is empty |
| 208 (Already Reported) | Request processed successfully through the cache. The response is different for each API, please refer to the operation's documentation |
| 400 (Bad Request) | Syntax error. For instance, when a required field was not provided. The response is as defined in BadRequestError |
| 401 (Unauthorized) | API key not provided or invalid. The response is as defined in UnauthorizedError |
| 403 (Forbidden) | API key is valid, but the application has insufficient permissions to complete the requested operation. The response is as defined in ForbiddenError |
| 404 (Not Found) | Cannot found the asked resource. The response is as defined in NotFoundError |
| 406 (Not Acceptable) | This is not acceptable to process the asked ressource (mature content, etc...). The response is as defined in NotAcceptableError |
| 409 (CONFLICT) | The ressource already exists. The response is as defined in ConflictError |
| 413 (Payload Too Large) | The request is larger than the server is willing or able to process. (video too long, etc...). The response is as defined in PayloadTooLargeError |
| 425 (Too Early) | The request try to update a resource before it's available. The response is as defined in TooEarlyError |
| 428 (Precondition Required) | The request is valid but you need to setup something before. The response is as defined in PreconditionRequiredError |
| 429 (Too Many Requests) | The user has sent too many requests in a given amount of time. The response is as defined in TooManyRequestsError |
| 500 (Internal Server Error) | API error. The response is as defined in InternalError |
Global Errors
Some of the main errors returned in a 400, 401, 403, 404 or 409 responses are provided below*:
- badRequest: Bad request
- missingApiKey: Missing API key
- unknownApiKey: Unknown API key
- expiredApiKey: Expired API key
- deletedApiKey: Deleted API key
- wrongApiKey: Wrong API key or API key doesnt have the needed permissions
- deletedVW: Deleted virtual world
- planLimitReached: You have reached your plan limit
- emoteNotAvailable: Emote not available for SDK usage
- emoteNotAllowed: Emote not allowed for SDK usage
- noUGC: Virtual world does not allow UGC
- alreadyExists: Resource already exists
*The errors shown above are the main errors. Nonetheless, this list is not comprehensive. New codes may be added anytime without previous warning.
Webhooks
It is recommended to subscribe to Webhook events instead of polling APIs. To do so, enable webhooks and register a URL that will receive a POST request whenever one of the events below occurs.
Servers