API referenceExtractions
Create a project
POST
/extractionsisQuick defaults to true (auto-scaffold a config chain). With isQuick:false you may pass sourceModuleId (clone a template) or moduleId (attach existing). isQuick is mutually exclusive with sourceModuleId/moduleId. ownerUserId names the human who owns the project and can open it in the UI; it must be an active user in your organization. Omit it and the user who created the API key becomes the owner.
Requires an API key with one of these roles: admin, editor.
Authorization
bearerAuth AuthorizationBearer <token>
An API key created in Settings → API Keys.
In: header
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
application/json
curl -X POST "https://example.com/extractions" \ -H "Content-Type: application/json" \ -d '{ "title": "string", "description": "string" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "moduleId": "eb49de5a-d93f-4a73-a032-bfeee6879098", "isActive": true, "inactivatedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "isQuick": true, "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "module": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "isProjectModule": true, "isBaseModule": true }, "userAssociations": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "projectAccessLevelId": "a4ae23eb-b0a8-4d0c-b6c8-04e1df49d77c", "isActive": true, "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "firstName": "string", "lastName": "string" } } ] }, "meta": { "requestId": "string", "timestamp": "string" }}