# Swagger/openapi documentation for API

**URL:** <https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856>\
**Category:** 🤝  Community Help\
**Created:** [November 30, 2023, 10:10am UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856 "2023-11-30T10:10:37Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![Alan\_Hollis](https://yyz1.discourse-cdn.com/flex029/user_avatar/discuss.roboflow.com/alan_hollis/32/2838_2.png) [@Alan\_Hollis](https://discuss.roboflow.com/u/Alan_Hollis)\
**Post date:** [November 30, 2023, 10:10am UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856/1 "2023-11-30T10:10:37Z")

</div>

Hi,

Is there any further documentation on the API endpoints available? I’ve managed to piece together enough from the existing documentation but it feels like I should be able to do so much more if I knew everything it supported ( or at least I could rule it out )

Thanks

Alan

---

<div class="post-metadata">

**Author:** ![Jacob\_Witt](https://yyz1.discourse-cdn.com/flex029/user_avatar/discuss.roboflow.com/jacob_witt/32/347_2.png) [@Jacob\_Witt](https://discuss.roboflow.com/u/Jacob_Witt)\
**Post date:** [November 30, 2023, 12:48pm UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856/2 "2023-11-30T12:48:21Z")

</div>

Hi @Alan_Hollis - do you mind sharing what information specifically you are looking for?

---

<div class="post-metadata">

**Author:** ![Alan\_Hollis](https://yyz1.discourse-cdn.com/flex029/user_avatar/discuss.roboflow.com/alan_hollis/32/2838_2.png) [@Alan\_Hollis](https://discuss.roboflow.com/u/Alan_Hollis)\
**Post date:** [November 30, 2023, 2:33pm UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856/3 "2023-11-30T14:33:42Z")

</div>

There’s nothing really specifically. But for example I was uploading annotations and the error response code showed me that there was an overwrite flag I could use.

Also I’m not sure if there’s a “format” argument so I could specific yolo/darknet txt files etc, I assume it’s auto-worked out by the extension, but there’s no clear documentation.

It also feels like there’s more stuff that’s likely available but not documented ( could be way off the mark here ) like being able to move an image from one split to another?

---

<div class="post-metadata">

**Author:** ![Jacob\_Witt](https://yyz1.discourse-cdn.com/flex029/user_avatar/discuss.roboflow.com/jacob_witt/32/347_2.png) [@Jacob\_Witt](https://discuss.roboflow.com/u/Jacob_Witt)\
**Post date:** [November 30, 2023, 2:48pm UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856/4 "2023-11-30T14:48:48Z")

</div>

Heard - sorry for the inconvenience. I’ll share this feedback with the team.

I know there is a more detailed API reference in our [Python package docs](https://roboflow.github.io/roboflow-python/) - not exactly what you’re looking for, but the code there should give more insight into existing capabilities of our endpoints.

---

<div class="post-metadata">

**Author:** ![Jacob\_Witt](https://yyz1.discourse-cdn.com/flex029/user_avatar/discuss.roboflow.com/jacob_witt/32/347_2.png) [@Jacob\_Witt](https://discuss.roboflow.com/u/Jacob_Witt)\
**Post date:** [December 1, 2023, 12:45pm UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856/5 "2023-12-01T12:45:47Z")

</div>

@Alan_Hollis - there is also more documentation in the `roboflow` CLI

 ![image](https://canada1.discourse-cdn.com/flex029/uploads/roboflow1/original/2X/b/bff155aa394aec7b34f4c0b5d540aa1ad3d95e7b.png)

---

<div class="post-metadata">

**Author:** ![leo](https://yyz1.discourse-cdn.com/flex029/user_avatar/discuss.roboflow.com/leo/32/2228_2.png) [@leo](https://discuss.roboflow.com/u/leo)\
**Post date:** [December 3, 2023, 12:34am UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856/6 "2023-12-03T00:34:03Z")

</div>

> [@Alan\_Hollis](#):
>
> Also I’m not sure if there’s a “format” argument so I could specific yolo/darknet txt files etc, I assume it’s auto-worked out by the extension, but there’s no clear documentation.

Hi @Alan_Hollis, to answer this specific question, in the REST API, annotation formats are auto-detected and we don’t have a way to specify formats at this time.

The `roboflow import` CLI command and the `import_dataset` method in the Roboflow Python function convert the dataset from the specified format into Pascal VOC and then pass it through to the API.

Is there a reason you are wanting to specify a format? Are you having trouble with the API recognizing your annotation files?

---

<div class="post-metadata">

**Author:** ![Alan\_Hollis](https://yyz1.discourse-cdn.com/flex029/user_avatar/discuss.roboflow.com/alan_hollis/32/2838_2.png) [@Alan\_Hollis](https://discuss.roboflow.com/u/Alan_Hollis)\
**Post date:** [December 3, 2023, 7:50am UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856/7 "2023-12-03T07:50:27Z")

</div>

Thanks guys.

The reason for the annotation ask was I originally tried to load annotations in yolo txt format but when I had multiline files it didn’t work.

I guessed VOC must be the default so tried converting from yolo to Voc and that worked perfectly.

---

<div class="post-metadata">

**Author:** ![system](https://canada1.discourse-cdn.com/flex029/uploads/roboflow1/original/1X/bb6edbfa56d0cf2ee603f061e9e09103502cc8cc.png) [@system](https://discuss.roboflow.com/u/system)\
**Post date:** [December 24, 2023, 7:51am UTC](https://discuss.roboflow.com/t/swagger-openapi-documentation-for-api/3856/8 "2023-12-24T07:51:07Z")

</div>

This topic was automatically closed 21 days after the last reply. New replies are no longer allowed.
