Retrieve a conversation.

GET

/conversations/{conversation_id}

curl --request GET \
  --url https://api.helping.io/v1/conversations/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• api_key

Parameters

Path Parameters

conversation_id

required

string

The opaque conv_... id of the conversation

Responses

200

The conversation.

Media typeapplication/json

A conversation.

OpenAI requires all four fields, so none of them is optional here and none is skipped when empty. metadata in particular: a conversation with no labels answers with {}, never with the field absent.

object

created_at

required

When the conversation was created, in seconds since the Unix epoch.

integer format: int64

id

required

The conversation’s opaque id, conv_....

string

metadata

required

The customer’s own labels on this conversation.

object

object

required

Always conversation.

string

Example^generated

{
  "created_at": 1,
  "id": "example",
  "metadata": {},
  "object": "example"
}

401

Missing or invalid API key (the error envelope)

403

The key is not entitled to what the request asked for (the error envelope)

404

No such conversation, or one this key cannot reach.

429

This organization has exhausted its retrieval allowance; retry after the Retry-After header.

500

The request could not be completed; quote the x-request-id response header when reporting it.

503

The request could not be served this instant; retry after the Retry-After header.