Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CURL/requests documentation to swagger docs #8237

Closed
ryanshrott opened this issue May 7, 2024 · 7 comments · Fixed by #8445
Closed

CURL/requests documentation to swagger docs #8237

ryanshrott opened this issue May 7, 2024 · 7 comments · Fixed by #8445
Assignees
Labels
docs/website Related to documentation or website

Comments

@ryanshrott
Copy link

How do I call the API with CURL in postman or requests module? Can someone please provide an example with documentation?

If this isn't possible, why not?

I used to be able to do it a year ago.

from gradio_client import Client

client = Client("Property-ca/photos")
result = client.predict(
mls_number="w5633330",
photo_base_url="/public/images/listings/optimized/w5633330/mls/",
number_of_images=5,
version=2,
api_name="/lambda"
)
print(result)

@pngwn
Copy link
Member

pngwn commented May 7, 2024

We will be adding documentation around this shortly. Thank you for creating an issue.

It is still possibly but it is a little more complex now. We won't be adding the documentation to the swagger docs but we will be adding it to the "Use via API" page.

@pngwn pngwn added the docs/website Related to documentation or website label May 7, 2024
@ryanshrott
Copy link
Author

@pngwn thank you. Adding to the "Use via API" docs is perfect. Do you know the timeline on that? Will it be in the next release?

@satokenta940
Copy link

It won't be added to the Swagger, so what about Apidog? I am currently using these two.

@ryanshrott
Copy link
Author

I was hoping it would be added to "View via API" button, just like we used to have these Python requests module, which is basically like curl requests.

@pngwn
Copy link
Member

pngwn commented May 27, 2024

Yes, it will.

@pablovela5620
Copy link

pablovela5620 commented May 31, 2024

We will be adding documentation around this shortly. Thank you for creating an issue.

It is still possibly but it is a little more complex now. We won't be adding the documentation to the swagger docs but we will be adding it to the "Use via API" page.

any timeline as to when CURL documentation will be added? I have something working thanks to this blogpost https://www.freddyboulton.com/blog/gradio-curl from @freddyaboulton . But there's still some things missing that I would like to do (for example authentication either from a private space or a password protected gradio app). I'm trying to call the API from a swift app so the python/js wont work for my usecase

EDIT----
In case anyone else finds this useful in the meantime, one just needs to add
-H "Authorization: Bearer $TOKEN" to the curl request for any private space where $TOKEN is the access token you generate on https://huggingface.co/settings/tokens

For example in the blog from freddy

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" -d '{"data": [3]}' http://127.0.0.1:7860/call/predict

@ryanshrott
Copy link
Author

I'm hoping soon as well! I miss curl requests :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs/website Related to documentation or website
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants