> For the complete documentation index, see [llms.txt](https://documentation.deep-image.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.deep-image.ai/api-methods.md).

# API methods

The API address is [https://deep-image.ai/rest\_api/](https://deep-image.ai/rest_api/v2/)

There are two methods for the scheduling image processing and one for retrieving the results. With "[process\_result](#post-rest_api-process_result)" method, image can be processed and if the result is available during 25 seconds, the url to the result will be returned. The second method - "[process](#post-rest_api-process)" - always schedules a processing job and the user has to wait for the result with "[result](#get-rest_api-result-hash)" method.

Processing methods supports both form-data and json content types.

{% openapi src="/files/3OFpeujvbewtPkDrg1oZ" path="/rest\_api/process\_result" method="post" %}
[swagger3.yml](https://2652559519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3i5YcUkcXyIsWHIhRO2d%2Fuploads%2F9qIlTUgwt8yeGrDr3N5w%2Fswagger3.yml?alt=media\&token=09f1c54e-f0e6-4337-98e1-0fa9658a8a4a)
{% endopenapi %}

{% openapi src="/files/RCWevyg9B6ovtEB9NnBM" path="/rest\_api/process" method="post" %}
[swagger3.yml](https://2652559519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3i5YcUkcXyIsWHIhRO2d%2Fuploads%2FQpwfcjdv3nmIvkENVmKH%2Fswagger3.yml?alt=media\&token=f0df3744-c5c6-46cc-ba15-ca08bfb97b71)
{% endopenapi %}

{% openapi src="/files/NNnrOenUh63lGfS6fD9k" path="/rest\_api/me" method="get" %}
[swagger.yml](https://2652559519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3i5YcUkcXyIsWHIhRO2d%2Fuploads%2F24UMPSGF40X9pRnpAWNl%2Fswagger.yml?alt=media\&token=b2dfe09d-cac2-464b-8951-e78b2e43847e)
{% endopenapi %}

{% openapi src="/files/8BT5nrgpCHb2E6yWWUKD" path="/rest\_api/result/{hash}" method="get" %}
[swagger.yml](https://2652559519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3i5YcUkcXyIsWHIhRO2d%2Fuploads%2FqYtZbzmlcCEbAoCqFOPJ%2Fswagger.yml?alt=media\&token=d397d18e-9be4-479d-b272-0c68531924bd)
{% endopenapi %}

{% openapi src="/files/CG8VboqFNlhUQYC2Teo1" path="/rest\_api/result/{hash}" method="delete" %}
[swagger.yml](https://2652559519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F3i5YcUkcXyIsWHIhRO2d%2Fuploads%2Fvj1xx256lm0WaAouIKLR%2Fswagger.yml?alt=media\&token=6c6e81c7-ff63-45ad-bc00-398e42f259d2)
{% endopenapi %}

{% hint style="info" %}
When processing is in progress, the result endpoint should be periodically checked for the complete status.
{% endhint %}