Skip to content

Commit a446ab8

Browse files
docs(api): updates to API spec (#216)
1 parent 90fd2ce commit a446ab8

3 files changed

Lines changed: 13 additions & 7 deletions

File tree

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 29
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-350e8ec39a0511510d9af6d1ba3e60154d0585a8a8732e50a2fd40ede8881dc1.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-57a138ff1e8940e627dd0108eb14c25bbeacd70e5f1106f8abd796cba6c51882.yml

src/writerai/types/application_generate_content_params.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,12 @@ class Input(TypedDict, total=False):
2929
value: Required[List[str]]
3030
"""The value for the input field.
3131
32-
If file is required you will need to pass a `file_id`. See
33-
[here](https://dev.writer.com/api-guides/api-reference/file-api/upload-files)
34-
for the Files API.
32+
If the input type is "File upload", you must pass the `file_id` of an uploaded
33+
file. You cannot pass a file object directly. See the
34+
[file upload endpoint](/api-guides/api-reference/file-api/upload-files) for
35+
instructions on uploading files or the
36+
[list files endpoint](/api-guides/api-reference/file-api/get-all-files) for how
37+
to see a list of uploaded files and their IDs.
3538
"""
3639

3740

src/writerai/types/applications/job_create_params.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ class Input(TypedDict, total=False):
2525
value: Required[List[str]]
2626
"""The value for the input field.
2727
28-
If file is required you will need to pass a `file_id`. See
29-
[here](https://dev.writer.com/api-guides/api-reference/file-api/upload-files)
30-
for the Files API.
28+
If the input type is "File upload", you must pass the `file_id` of an uploaded
29+
file. You cannot pass a file object directly. See the
30+
[file upload endpoint](/api-guides/api-reference/file-api/upload-files) for
31+
instructions on uploading files or the
32+
[list files endpoint](/api-guides/api-reference/file-api/get-all-files) for how
33+
to see a list of uploaded files and their IDs.
3134
"""

0 commit comments

Comments
 (0)