Create a document

POST

1 from flatfile import Flatfile
2 from flatfile.commons import Action
3 
4 client = Flatfile(
5     token="YOUR_TOKEN",
6 )
7 client.documents.create(
8     space_id="us_sp_YOUR_ID",
9     title="My Document 1",
10     body="My information",
11     actions=[
12         Action(
13             operation="submitAction",
14             mode="foreground",
15             label="Submit",
16             description="Submit data to webhook.site",
17             primary=True,
18         )
19     ],
20 )

Play

200Example0

1 {
2   "data": {
3     "body": "My information",
4     "createdAt": "2022-09-18T00:19:57.007Z",
5     "id": "us_dc_YOUR_ID",
6     "title": "My Document 1",
7     "updatedAt": "2022-09-18T00:19:57.007Z",
8     "actions": [
9       {
10         "label": "Submit",
11         "description": "Submit data to webhook.site",
12         "mode": "foreground",
13         "operation": "submitAction",
14         "primary": true
15       }
16     ],
17     "environmentId": "us_env_YOUR_ID",
18     "spaceId": "us_sp_YOUR_ID",
19     "treatments": []
20   }
21 }

Add a new document to the space

Path parameters

spaceIdstringRequired

ID of space to return

Request

This endpoint expects an object.

titlestringRequired

bodystringRequired

treatmentslist of stringsOptional

Certain treatments will cause your Document to look or behave differently.

actionslist of objectsOptional

Response

This endpoint returns an object.

dataobject

A document (markdown components) belong to a space

Create a document

Path parameters

Headers

Request

Response

Errors