Humata API

The Humata API is the programmatic entry-point for your Humata documents, conversations, and answers.

Setup

Here are the 3-steps to use the Humata API after you sign up:

1. Create a Humata API Key on the Developer Settings Page (Admin only)

2. Copy your Document IDs from the Humata Dashboard

3. Make API Requests

Endpoints

Conversations

Create a conversation with a set of documents. A conversation must be created before asking questions to documents.

Create Conversation

Creates a new conversation based on the document IDs.

POSThttps://app.humata.ai/api/v1/conversations

Authorization

ApiKeyAuth

Body

application/json

documentIds*array of string (uuid)

Response

200401429

Successfully created a new conversation.

Body

application/json

idstring (uuid)

The unique identifier of the created conversation.

Request

JavaScriptCurlPython

const response = await fetch('https://app.humata.ai/api/v1/conversations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "documentIds": [
        "63ea1432-d6aa-49d4-81ef-07cb1692f2ee",
        "cbec39d9-1e01-409c-9fc2-f19f5d01005c"
      ]
    }),
});
const data = await response.json();

Response

200401429

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Ask

Humata allows you to chat with your document via the Ask endpoint. Create a conversation and then ask your documents

Ask in a Conversation

Ask a question in a conversation. Response is streamed via server-sent events.

POSThttps://app.humata.ai/api/v1/ask

Authorization

ApiKeyAuth

Body

application/json

conversationId*string (uuid)

model*enum

gpt-4-turbo-preview

question*string

selectedAnswerApproachenum

GroundedBalancedCreative

Response

200401429

Successfully answered the question.

Body

text/event-stream

string

Request

JavaScriptCurlPython

const response = await fetch('https://app.humata.ai/api/v1/ask', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "conversationId": "7290fd6b-fe15-4fd3-865e-8010bd8e8a38",
      "model": "gpt-4-turbo-preview",
      "question": "Who is George Washington?"
    }),
});
const data = await response.json();

Response

200401429

text

Server-Sent Events

The Ask Endpoint returns a stream of server-sent events. Here is a full example of response to the question "Who is George Washington?":

data: { 'content': 'George Washington was ' }
data: { 'content': 'the first ' }
data: { 'content': 'president of the United States[3].' }
data: { 'content': '\n\nReferences - [3]: Page 10 of History of the United States.pdf' }

References

Each answer from Humata will provide references to the parts of the document that our AI used to answer the question. The format of references is subject to change.

FAQ

What is the API rate limit?

By default the API rate limit is 120 requests / minute. This rate limit can be increased by request. Please reach out to [e-mail] to get this limit raised.