List Interactions

curl --request POST \
  --url https://app.apigene.ai/api/interaction/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "interactions": [
    {
      "_id": "<string>",
      "user_id": "<string>",
      "api_name": "<string>",
      "user_input": "<string>",
      "created_at": "<string>",
      "duration": 123,
      "status_code": 123,
      "response_size": 123,
      "api_title": "<string>"
    }
  ],
  "count": 123
}

Interaction

List Interactions

List interactions metadata (optimized for table display).

This endpoint returns only metadata for interactions to improve performance. Use /interaction/ to get full interaction details.

Parameters:

api_name: Name of the API (optional).
page: Page number for pagination (default: 1).
limit: Maximum number of interactions per page (default: 50).
sort_by: Field to sort interactions by (optional).
sort_order: Sorting order (‘asc’ or ‘desc’) (default: ‘asc’).
filters: Additional filters for querying interactions (optional).
current_user: Current user for authentication (required for admin role).

Returns:

List of interaction metadata (without large response data).

Raises:

HTTPException(401): If the user is not authorized.

POST

api

interaction

list

List Interactions

curl --request POST \
  --url https://app.apigene.ai/api/interaction/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "interactions": [
    {
      "_id": "<string>",
      "user_id": "<string>",
      "api_name": "<string>",
      "user_input": "<string>",
      "created_at": "<string>",
      "duration": 123,
      "status_code": 123,
      "response_size": 123,
      "api_title": "<string>"
    }
  ],
  "count": 123
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'

Query Parameters

api_name

string | null

page

integer

default:1

limit

integer

default:50

sort_by

string | null

sort_order

string | null

default:asc

Body

application/json

The body is of type Filters · object.

Response

Successful Response

interactions

InteractionMetadata · object[]

required

List of interaction metadata.

Show child attributes

count

integer

required

Total number of interactions matching the query.

Get Summary Get Interaction Detail