"The C3 AI Suite provides RESTful APIs to provide programmatic access to all Types and all methods in a C3 application. By default, all Types have automatically-generated REST APIs–there is no need to define or construct API endpoints manually." (From official C3 documentation on RESTful APIs)
URLs for C3 REST API requests have the following format:
https://<vanity_url>/api/<api_version>/<type>?action=<method>
<vanity_url>
is the base url for your C3 tag<api_version>
is the current version of the REST API which is 1.<type>
is the C3 Type name. Type names are case sensitive.<method>
is the C3 Type method to callRequired arguments to methods must be passed via the HTTP request body in json format. For example when calling the fetch()
method, we must pass a spec parameter. This can be passed with a json formatted payload like this:
{
"spec": {
"limit": 10,
"include": "id, name, bulbType"
}
}
Header | Description | Possible Values |
---|---|---|
Accept | Indicates the media types which are acceptable for the response | application/json application/xml (default) |
Content-Type | Indicates the media type of the entity-body sent to the recipient | application/json |
Request-Method | Indicates the desired action to be performed for the resource | POST |
Authorization | Username and Password |
Official Documentation (Please note this page currently closely mirrors that available at the official documentation):