https://<org_api_endpoint>/<org_name>/v2/<api_resource>
org_environment_endpoint
is the proper API endpoint for your org environmentorg_name
is the name you provided when signing upapi_resource
is the Cortex API resource you are accessing. This could be a Cortex object or a custom route.Generate API Key
. Additionally, if you configure your app with CSRF protection, a Medable-Csrf-Token will also be required. In this case, each authenticated request will return an HTTP response header of the same name, and the subsequent request must contain the value of that response header.GET
requests let you read one or many instances of a resource. They typically take one of two formsGET /<object_name>/<object_id>
GET /<object_name>/<object_id>/<property_path>
POST
requests allow you to create a new object instance from the request body. If the request is applied to an array property, the new array elements are pushed onto the existing array.PUT
requests allow you to update an existing object instance with the contents of the request body for the provided object instance _id. If the request is applied to an array property, the entire array is replaced with the request body.PATCH
requests let you chain operations together on an object instance in one request. For example, if you have an object instance that you'd like to update the value of one property (ordinarily a PUT
request), push a value into an array property (ordinarily a POST
request on a path), and delete another property (ordinarily a DELETE
request on a path), that would take three requests. However, with a PATCH
, you can achieve this in one request containing three operations.DELETE
requests allow you to delete the object instance for the provided object _idDELETE /<object_name>/<object_id>
For additional examples and details on making Cortex API requests, see First API Request