Mojo UpDocs
API reference

Project conversations

Share a conversation live, or take it back

PUT/projects/v1/{id}/me/conversations/{cid}/audience

The owner of one of their own Chat or Research conversations in a project (AIOE 0.41.0). Shares it with the whole project or with named members, or makes it private again (person). Only members of the project can be named. Audited.

Authorization

AuthorizationBearer <token>

A device access token from the device-code flow (aioe_at_…). A DPoP-bound token is sent as Authorization: DPoP <token> with a fresh DPoP proof on every request.

In: header

Path Parameters

id*string

The project.

cid*string

The conversation.

Header Parameters

X-Aioe-Organisation?string

Mojo Up AI Cloud only, with a person's access token: the id of the organisation the request is for. A person's session is not tied to one organisation, so each request names it. Device tokens already carry their organisation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/projects/v1/string/me/conversations/string/audience" \  -H "Content-Type: application/json" \  -d '{    "audience": {      "kind": "person"    }  }'
{}

Conversations shared with me

GET/projects/v1/{id}/conversations/shared

For members of the project (AIOE 0.41.0): the Chat and Research conversations people shared live with the caller or with the whole project, each with its owner.

Authorization

AuthorizationBearer <token>

A device access token from the device-code flow (aioe_at_…). A DPoP-bound token is sent as Authorization: DPoP <token> with a fresh DPoP proof on every request.

In: header

Path Parameters

id*string

The project.

Query Parameters

kind?string

chat or research; both by default.

Value in

  • "chat"
  • "research"
since?integer

Only changes after this sequence number.

limit?integer

At most 500.

Range1 <= value <= 500
Default200

Header Parameters

X-Aioe-Organisation?string

Mojo Up AI Cloud only, with a person's access token: the id of the organisation the request is for. A person's session is not tied to one organisation, so each request names it. Device tokens already carry their organisation.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/projects/v1/string/conversations/shared"
{  "seq": 0,  "conversations": [    {}  ]}

Read a person's conversation

GET/projects/v1/{id}/conversations/{principal}/{cid}

For members of the project (AIOE 0.41.0): the owner's own conversation, or one shared with the caller. Anything else answers not found, so changing an audience does not reveal that a conversation exists.

Authorization

AuthorizationBearer <token>

A device access token from the device-code flow (aioe_at_…). A DPoP-bound token is sent as Authorization: DPoP <token> with a fresh DPoP proof on every request.

In: header

Path Parameters

id*string

The project.

principal*string

The conversation's owner.

cid*string

The conversation.

Header Parameters

X-Aioe-Organisation?string

Mojo Up AI Cloud only, with a person's access token: the id of the organisation the request is for. A person's session is not tied to one organisation, so each request names it. Device tokens already carry their organisation.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/projects/v1/string/conversations/string/string"
{}

Read a conversation's messages

GET/projects/v1/{id}/conversations/{principal}/{cid}/messages

For members of the project (AIOE 0.41.0): a page of the messages of a conversation the caller may read (see the conversation itself).

Authorization

AuthorizationBearer <token>

A device access token from the device-code flow (aioe_at_…). A DPoP-bound token is sent as Authorization: DPoP <token> with a fresh DPoP proof on every request.

In: header

Path Parameters

id*string

The project.

principal*string

The conversation's owner.

cid*string

The conversation.

Query Parameters

after?integer

Only entries after this sequence number.

Range0 <= value
Default0
limit?integer

At most 500.

Range1 <= value <= 500
Default500

Header Parameters

X-Aioe-Organisation?string

Mojo Up AI Cloud only, with a person's access token: the id of the organisation the request is for. A person's session is not tied to one organisation, so each request names it. Device tokens already carry their organisation.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/projects/v1/string/conversations/string/string/messages"
{  "entries": [    {}  ],  "more": true}