Package ai.extend.resources.editruns

Class EditRunsClient

java.lang.Object

ai.extend.resources.editruns.EditRunsClient

Direct Known Subclasses:

EditRunsClient

public class EditRunsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
EditRunsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
EditRun	create(EditRunsCreateRequest request)	Edit and manipulate PDF documents by detecting and filling form fields.
EditRun	create(EditRunsCreateRequest request, RequestOptions requestOptions)	Edit and manipulate PDF documents by detecting and filling form fields.
EditRunsDeleteResponse	delete(java.lang.String id)	Delete an edit run and all associated data from Extend.
EditRunsDeleteResponse	delete(java.lang.String id, RequestOptions requestOptions)	Delete an edit run and all associated data from Extend.
EditRun	retrieve(java.lang.String id)	Retrieve the status and results of an edit run.
EditRun	retrieve(java.lang.String id, RequestOptions requestOptions)	Retrieve the status and results of an edit run.
RawEditRunsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

EditRunsClient

public EditRunsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawEditRunsClient withRawResponse()

Get responses with HTTP metadata like headers

create

public EditRun create(EditRunsCreateRequest request)

Edit and manipulate PDF documents by detecting and filling form fields.

The Edit Runs endpoint allows you to convert and edit documents and get an edit run ID that can be used to check status and retrieve results with the Get Edit Run endpoint.

For more details, see the Edit File guide.

create

public EditRun create(EditRunsCreateRequest request,
                      RequestOptions requestOptions)

Edit and manipulate PDF documents by detecting and filling form fields.

The Edit Runs endpoint allows you to convert and edit documents and get an edit run ID that can be used to check status and retrieve results with the Get Edit Run endpoint.

For more details, see the Edit File guide.

retrieve

public EditRun retrieve(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 edit run initiated via the Create Edit Run endpoint.

retrieve

public EditRun retrieve(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 edit run initiated via the Create Edit Run endpoint.

delete

public EditRunsDeleteResponse 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 EditRunsDeleteResponse 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.