Class RawEditClient
- java.lang.Object
-
- ai.extend.resources.edit.RawEditClient
-
public class RawEditClient extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description protected ClientOptionsclientOptions
-
Constructor Summary
Constructors Constructor Description RawEditClient(ClientOptions clientOptions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExtendClientHttpResponse<EditRun>create(EditCreateRequest request)Edit and manipulate PDF documents by detecting and filling form fields.ExtendClientHttpResponse<EditRun>create(EditCreateRequest request, RequestOptions requestOptions)Edit and manipulate PDF documents by detecting and filling form fields.ExtendClientHttpResponse<EditRunStatus>createAsync(EditCreateAsyncRequest request)Edit and manipulate PDF documents asynchronously by filling forms, adding/modifying text fields, and applying structured changes.ExtendClientHttpResponse<EditRunStatus>createAsync(EditCreateAsyncRequest request, RequestOptions requestOptions)Edit and manipulate PDF documents asynchronously by filling forms, adding/modifying text fields, and applying structured changes.ExtendClientHttpResponse<EditDeleteResponse>delete(java.lang.String id)Delete an edit run and all associated data from Extend.ExtendClientHttpResponse<EditDeleteResponse>delete(java.lang.String id, RequestOptions requestOptions)Delete an edit run and all associated data from Extend.ExtendClientHttpResponse<EditGetResponse>get(java.lang.String id)Retrieve the status and results of an edit run.ExtendClientHttpResponse<EditGetResponse>get(java.lang.String id, RequestOptions requestOptions)Retrieve the status and results of an edit run.
-
-
-
Field Detail
-
clientOptions
protected final ClientOptions clientOptions
-
-
Constructor Detail
-
RawEditClient
public RawEditClient(ClientOptions clientOptions)
-
-
Method Detail
-
create
public ExtendClientHttpResponse<EditRun> create(EditCreateRequest request)
Edit and manipulate PDF documents by detecting and filling form fields. This is a synchronous endpoint that will wait for the edit operation to complete (up to 5 minutes) before returning results. For longer operations, use the Edit File Async endpoint.
-
create
public ExtendClientHttpResponse<EditRun> create(EditCreateRequest request, RequestOptions requestOptions)
Edit and manipulate PDF documents by detecting and filling form fields. This is a synchronous endpoint that will wait for the edit operation to complete (up to 5 minutes) before returning results. For longer operations, use the Edit File Async endpoint.
-
createAsync
public ExtendClientHttpResponse<EditRunStatus> createAsync(EditCreateAsyncRequest request)
Edit and manipulate PDF documents asynchronously by filling forms, adding/modifying text fields, and applying structured changes.The Edit Async endpoint allows you to convert and edit documents asynchronously and get an edit run ID that can be used to check status and retrieve results with the Get Edit Run endpoint.
This is useful for:
- Large files that may take longer to process
- Avoiding timeout issues with synchronous editing
- Processing multiple files in parallel
-
createAsync
public ExtendClientHttpResponse<EditRunStatus> createAsync(EditCreateAsyncRequest request, RequestOptions requestOptions)
Edit and manipulate PDF documents asynchronously by filling forms, adding/modifying text fields, and applying structured changes.The Edit Async endpoint allows you to convert and edit documents asynchronously and get an edit run ID that can be used to check status and retrieve results with the Get Edit Run endpoint.
This is useful for:
- Large files that may take longer to process
- Avoiding timeout issues with synchronous editing
- Processing multiple files in parallel
-
get
public ExtendClientHttpResponse<EditGetResponse> get(java.lang.String id)
Retrieve the status and results of an edit run.Use this endpoint to get results for an edit run that has already completed, or to check on the status of an asynchronous edit run initiated via the Edit File Asynchronously endpoint.
If editing is still in progress, you'll receive a response with just the status. Once complete, you'll receive the full edited file information in the response.
-
get
public ExtendClientHttpResponse<EditGetResponse> get(java.lang.String id, RequestOptions requestOptions)
Retrieve the status and results of an edit run.Use this endpoint to get results for an edit run that has already completed, or to check on the status of an asynchronous edit run initiated via the Edit File Asynchronously endpoint.
If editing is still in progress, you'll receive a response with just the status. Once complete, you'll receive the full edited file information in the response.
-
delete
public ExtendClientHttpResponse<EditDeleteResponse> delete(java.lang.String id)
Delete an edit run and all associated data from Extend. This operation is permanent and cannot be undone.This endpoint can be used if you'd like to manage data retention on your own rather than relying on automated data retention policies, or to make one-off deletions for your downstream customers.
-
delete
public ExtendClientHttpResponse<EditDeleteResponse> delete(java.lang.String id, RequestOptions requestOptions)
Delete an edit run and all associated data from Extend. This operation is permanent and cannot be undone.This endpoint can be used if you'd like to manage data retention on your own rather than relying on automated data retention policies, or to make one-off deletions for your downstream customers.
-
-