Execute a research run

POST

/v1/characters/:slug/research/runs/:run_id/execute

POST

/v1/characters/:slug/research/runs/:run_id/execute

$ curl -X POST https://api.loreos.app/v1/characters/slug/research/runs/run_id/execute \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "slug": "arthur-dent",
4   "status": "completed",
5   "startedAt": "2024-06-01T10:15:30Z",
6   "completedAt": "2024-06-01T10:17:45Z",
7   "results": {
8     "summary": "Research run executed successfully with 5 relevant documents found.",
9     "documentsFound": 5,
10     "evidence": [
11       {
12         "title": "The Hitchhiker's Guide to the Galaxy",
13         "url": "https://example.com/hitchhikers-guide",
14         "snippet": "Arthur Dent is a human from Earth who embarks on a space adventure."
15       },
16       {
17         "title": "Arthur Dent Character Analysis",
18         "url": "https://example.com/arthur-dent-analysis",
19         "snippet": "Arthur Dent is known for his dry wit and reluctant heroism."
20       }
21     ]
22   }
23 }

Authentication

AuthorizationBearer

LoreOS API key, sent as Authorization: Bearer <key>.

Path parameters

slugstringRequired

run_idstringRequiredformat: "uuid"

Response

Successful Response

Errors

422

Unprocessable Entity Error