Getting Started

The Arva API is a JSON over HTTP API that allows you to interact with the Arva platform programatically. The API can be found at:

https://platform.arva-ai.com/api/v0

In order to interact with the API, you must first generate an API key. You can generate and revoke API keys in the API keys tab of the Arva platform. Remember to keep your API keys secure and not share them with anyone.

Once you have generated an API key, you can use it to authenticate your requests to the API. To authenticate your requests, you will need to include your API key as a bearer token in the Authorization header. These docs will include examples in cURL and Python, but the API can be interacted with with any HTTP client.

curl -X POST https://platform.arva-ai.com/api/v0/<endpoint> \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-d '<request_body>'

npm i @arva-ai/sdk

import { Arva } from '@arva-ai/sdk'

const client = new Arva(
  '<YOUR_API_KEY>'
)

import requests

response = requests.post(
    "https://platform.arva-ai.com/api/v0/<endpoint>",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json=<request_body>
)

pip install arva-sdk

from arva import Arva

client = Arva(
    api_key='<YOUR_API_KEY>'
)

Next, see how you can open a new case with the API.