Create Project
💡 Every time you use the OAuth credentials, every project will be created on behalf of the registered user’s credentials. This will be beneficial if you want to create multiple projects, and the project owner will always be the same.
We also have a Python script example for this. To make the API request, you can follow these step-by-step guide, specifically the one with multipart request.
Since it's an asynchronous process, the response is only information about the job, not the created project. You would have to check the job periodically to make sure whether the project is successfully created.
Since the project creation is quite complex, it's recommended to configure the payload of the API request by following these steps.
- 1.Use the Project Creation Wizard (PCW) first. You can try all the way until a project is created and make sure the result is as expected. Then, open the PCW and configure the exact same way as before until the last step.
- 2.Once you are sure with the configuration, click the
View Scriptin the top right corner of the page. - 3.Then, you can just copy and paste the whole JSON object as the payload when requesting the GraphQL API.
As you can see on the input API docs, there is
documents attribute which accept array of CreateTextDocumentInput. Map the uploaded file to the file attribute on this object for each documents that will be used in the project.{
"operations": {...},
"map": {
"firstFile": ["variables.input.documents.0.file"],
"secondFile": ["variables.input.documents.1.file"]
},
"firstFile": "...",
"secondFile": "..."
}
By default, the label set or question set (depending on the project type that will be created) should have been already configured via PCW. The full explanation can be seen here.
- Specific for token labeling, the attribute will be
labelSets. The detailed of the API payload can be seen here. - Specific for bounding box, the attribute will be
bboxLabelSets. The detailed of the API payload can be seen here. - Specific for row and doc labeling, the attribute will be
documents.settings.questionsthat will represent the question sets. The detailed of the object can be seen here.
Last modified 3mo ago