Skip to content

Basic Documentation and Examples for using API #3734

Answered by Kilvoctu
ClashSAN asked this question in Q&A
Discussion options

You must be logged in to vote

I am not a programmer so my knowledge is very limited, but nonetheless after a lot of banging sticks together I was able to figure out how to use the API (small tangential gripe, highly technical and experienced people are not very good at helping beginners how to code).

I'll go through everything I learned about how to interface with the API. Apologies if I get a lot of terms and such wrong:

  • First, of course, is to run web ui with --api commandline argument

    • example in your "webui-user.bat": set COMMANDLINE_ARGS=--api
  • This enables the api which can be reviewed at http://127.0.0.1:7860/docs (or whever the URL is + /docs)
    The basic ones I'm interested in are these two. Let's just focu…

Replies: 54 comments 97 replies

Comment options

You must be logged in to vote
6 replies
@ClashSAN
Comment options

ClashSAN Oct 27, 2022
Collaborator Author

@Kilvoctu
Comment options

@acoudouy
Comment options

@ed5464215
Comment options

@up_the_irons
Comment options

Answer selected by ClashSAN
Comment options

You must be logged in to vote
9 replies
@philpax
Comment options

@snusnumrik
Comment options

@Bruce-shuai
Comment options

@wutzebaer
Comment options

@dougkusanagi
Comment options

Comment options

You must be logged in to vote
1 reply
@Kilvoctu
Comment options

Comment options

You must be logged in to vote
2 replies
@anwac
Comment options

@hd-x
Comment options

Comment options

You must be logged in to vote
6 replies
@hd-x
Comment options

@philpax
Comment options

@Kilvoctu
Comment options

@vilhelmfl
Comment options

@ashleykleynhans
Comment options

Comment options

You must be logged in to vote
1 reply
@hd-x
Comment options

Comment options

You must be logged in to vote
3 replies
@Kilvoctu
Comment options

@F4brizio
Comment options

@e68862230
Comment options

Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
4 replies
@Jasongenius
Comment options

@adaloveless
Comment options

@ivan-valkyrie
Comment options

@VHAE04
Comment options

Comment options

You must be logged in to vote
3 replies
@Kilvoctu
Comment options

@Jasongenius
Comment options

@VHAE04
Comment options

Comment options

You must be logged in to vote
2 replies
@Kilvoctu
Comment options

@c00lcoder
Comment options

Comment options

You must be logged in to vote
4 replies
@ClashSAN
Comment options

ClashSAN Nov 11, 2022
Collaborator Author

@huotarih
Comment options

@Kilvoctu
Comment options

@s-lincke
Comment options

Comment options

You must be logged in to vote
4 replies
@Kilvoctu
Comment options

@adenta
Comment options

@Kilvoctu
Comment options

@Kilvoctu
Comment options

Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
1 reply
@valdesguefa
Comment options

Comment options

You must be logged in to vote
4 replies
@amputator84
Comment options

@harimayco
Comment options

@zero01101
Comment options

@harimayco
Comment options

Comment options

You must be logged in to vote
2 replies
@harimayco
Comment options

@aryswisnu
Comment options

Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
2 replies
@taliaa15
Comment options

@pen9yan
Comment options

Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
1 reply
@ashleykleynhans
Comment options

Comment options

You must be logged in to vote
0 replies
Comment options

You must be logged in to vote
2 replies
@mix1009
Comment options

@muhammadhur2
Comment options

Comment options

You must be logged in to vote
1 reply
@w-e-w
Comment options

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
documentation Improvements or additions to documentation